A string that represents the budget name. The \":\" and \"\\\" characters aren't allowed.
", + "base": "A string that represents the budget name. The \":\" and \"\\\" characters, and the \"/action/\" substring, aren't allowed.
", "refs": { "Action$BudgetName": null, - "Budget$BudgetName": "The name of a budget. The name must be unique within an account. The : and \\ characters aren't allowed in BudgetName.
The name of a budget. The name must be unique within an account. The : and \\ characters, and the \"/action/\" substring, aren't allowed in BudgetName.
The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
", + "base": "The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
", "refs": { } }, diff --git a/src/data/budgets/2016-10-20/docs-2.json.php b/src/data/budgets/2016-10-20/docs-2.json.php index ab14e3cc22..e77d231e26 100644 --- a/src/data/budgets/2016-10-20/docs-2.json.php +++ b/src/data/budgets/2016-10-20/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.
Budgets provide you with a way to see the following information:
How close your plan is to your budgeted amount or to the free tier limits
Your usage-to-date, including how much you\'ve used of your Reserved Instances (RIs)
Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
How much of your budget has been used
Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:
Cost budgets - Plan how much you want to spend on a service.
Usage budgets - Plan how much you want to use one or more services.
RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.
RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.
Service Endpoint
The Amazon Web Services Budgets API provides the following endpoint:
https://budgets.amazonaws.com
For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
', 'operations' => [ 'CreateBudget' => 'Creates a budget and, if included, notifications and subscribers.
Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Creates a budget action.
', 'CreateNotification' => 'Creates a notification. You must create the budget before you create the associated notification.
', 'CreateSubscriber' => 'Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
', 'DeleteBudget' => 'Deletes a budget. You can delete your budget at any time.
Deleting a budget also deletes the notifications and subscribers that are associated with that budget.
Deletes a budget action.
', 'DeleteNotification' => 'Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
Describes a budget.
The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Describes a budget action detail.
', 'DescribeBudgetActionHistories' => 'Describes a budget action history detail.
', 'DescribeBudgetActionsForAccount' => 'Describes all of the budget actions for an account.
', 'DescribeBudgetActionsForBudget' => 'Describes all of the budget actions for a budget.
', 'DescribeBudgetNotificationsForAccount' => 'Lists the budget names and notifications that are associated with an account.
', 'DescribeBudgetPerformanceHistory' => 'Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn\'t available for ANNUAL budgets.
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Lists the notifications that are associated with a budget.
', 'DescribeSubscribersForNotification' => 'Lists the subscribers that are associated with a notification.
', 'ExecuteBudgetAction' => 'Executes a budget action.
', 'UpdateBudget' => 'Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until Amazon Web Services has new usage data to use for forecasting.
Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Updates a budget action.
', 'UpdateNotification' => 'Updates a notification.
', 'UpdateSubscriber' => 'Updates a subscriber.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You are not authorized to use this operation with the given parameters.
', 'refs' => [], ], 'AccountId' => [ 'base' => 'The account ID of the user. It\'s a 12-digit number.
', 'refs' => [ 'CreateBudgetActionRequest$AccountId' => NULL, 'CreateBudgetActionResponse$AccountId' => NULL, 'CreateBudgetRequest$AccountId' => 'The accountId that is associated with the budget.
The accountId that is associated with the budget that you want to create a notification for.
The accountId that is associated with the budget that you want to create a subscriber for.
The accountId that is associated with the budget that you want to delete.
The accountId that is associated with the budget whose notification you want to delete.
The accountId that is associated with the budget whose subscriber you want to delete.
The accountId that is associated with the budget that you want a description of.
The accountId that is associated with the budgets that you want descriptions of.
The accountId that is associated with the budget whose notifications you want descriptions of.
The accountId that is associated with the budget whose subscribers you want descriptions of.
The accountId that is associated with the budget that you want to update.
The accountId that is associated with the budget whose notification you want to update.
The accountId that is associated with the budget whose subscriber you want to update.
A budget action resource.
', 'refs' => [ 'ActionHistoryDetails$Action' => 'The budget action resource.
', 'Actions$member' => NULL, 'DeleteBudgetActionResponse$Action' => NULL, 'DescribeBudgetActionResponse$Action' => 'A budget action resource.
', 'UpdateBudgetActionResponse$OldAction' => 'The previous action resource information.
', 'UpdateBudgetActionResponse$NewAction' => 'The updated action resource information.
', ], ], 'ActionHistories' => [ 'base' => NULL, 'refs' => [ 'DescribeBudgetActionHistoriesResponse$ActionHistories' => 'The historical record of the budget action resource.
', ], ], 'ActionHistory' => [ 'base' => 'The historical records for a budget action.
', 'refs' => [ 'ActionHistories$member' => NULL, ], ], 'ActionHistoryDetails' => [ 'base' => 'The description of the details for the event.
', 'refs' => [ 'ActionHistory$ActionHistoryDetails' => 'The description of the details for the event.
', ], ], 'ActionId' => [ 'base' => NULL, 'refs' => [ 'Action$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'CreateBudgetActionResponse$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'DeleteBudgetActionRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'DescribeBudgetActionHistoriesRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'DescribeBudgetActionRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'ExecuteBudgetActionRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'ExecuteBudgetActionResponse$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'UpdateBudgetActionRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'Action$Status' => 'The status of the action.
', 'ActionHistory$Status' => 'The status of action at the time of the event.
', ], ], 'ActionSubType' => [ 'base' => NULL, 'refs' => [ 'SsmActionDefinition$ActionSubType' => 'The action subType.
', ], ], 'ActionThreshold' => [ 'base' => 'The trigger threshold of the action.
', 'refs' => [ 'Action$ActionThreshold' => 'The trigger threshold of the action.
', 'CreateBudgetActionRequest$ActionThreshold' => NULL, 'UpdateBudgetActionRequest$ActionThreshold' => NULL, ], ], 'ActionType' => [ 'base' => NULL, 'refs' => [ 'Action$ActionType' => 'The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.
', 'CreateBudgetActionRequest$ActionType' => 'The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.
', ], ], 'Actions' => [ 'base' => NULL, 'refs' => [ 'DescribeBudgetActionsForAccountResponse$Actions' => 'A list of the budget action resources information.
', 'DescribeBudgetActionsForBudgetResponse$Actions' => 'A list of the budget action resources information.
', ], ], 'AdjustmentPeriod' => [ 'base' => NULL, 'refs' => [ 'HistoricalOptions$BudgetAdjustmentPeriod' => 'The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:
For the DAILY granularity, the maximum value is 60.
For the MONTHLY granularity, the maximum value is 12.
For the QUARTERLY granularity, the maximum value is 4.
For the ANNUALLY granularity, the maximum value is 1.
The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.
For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.
You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.
This specifies if the action needs manual or automatic approval.
', 'CreateBudgetActionRequest$ApprovalModel' => 'This specifies if the action needs manual or automatic approval.
', 'UpdateBudgetActionRequest$ApprovalModel' => 'This specifies if the action needs manual or automatic approval.
', ], ], 'AutoAdjustData' => [ 'base' => 'The parameters that determine the budget amount for an auto-adjusting budget.
', 'refs' => [ 'Budget$AutoAdjustData' => 'The parameters that determine the budget amount for an auto-adjusting budget.
', ], ], 'AutoAdjustType' => [ 'base' => NULL, 'refs' => [ 'AutoAdjustData$AutoAdjustType' => 'The string that defines whether your budget auto-adjusts based on historical or forecasted data.
', ], ], 'Budget' => [ 'base' => 'Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.
This is the Amazon Resource Name (ARN) pattern for a budget:
arn:aws:budgets::AccountId:budget/budgetName
The budget object that you want to create.
', 'DescribeBudgetResponse$Budget' => 'The description of the budget.
', 'UpdateBudgetRequest$NewBudget' => 'The budget that you want to update your budget to.
', ], ], 'BudgetName' => [ 'base' => 'A string that represents the budget name. The ":" and "\\" characters aren\'t allowed.
', 'refs' => [ 'Action$BudgetName' => NULL, 'Budget$BudgetName' => 'The name of a budget. The name must be unique within an account. The : and \\ characters aren\'t allowed in BudgetName.
The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.
', 'CreateSubscriberRequest$BudgetName' => 'The name of the budget that you want to subscribe to. Budget names must be unique within an account.
', 'DeleteBudgetActionRequest$BudgetName' => NULL, 'DeleteBudgetActionResponse$BudgetName' => NULL, 'DeleteBudgetRequest$BudgetName' => 'The name of the budget that you want to delete.
', 'DeleteNotificationRequest$BudgetName' => 'The name of the budget whose notification you want to delete.
', 'DeleteSubscriberRequest$BudgetName' => 'The name of the budget whose subscriber you want to delete.
', 'DescribeBudgetActionHistoriesRequest$BudgetName' => NULL, 'DescribeBudgetActionRequest$BudgetName' => NULL, 'DescribeBudgetActionResponse$BudgetName' => NULL, 'DescribeBudgetActionsForBudgetRequest$BudgetName' => NULL, 'DescribeBudgetPerformanceHistoryRequest$BudgetName' => NULL, 'DescribeBudgetRequest$BudgetName' => 'The name of the budget that you want a description of.
', 'DescribeNotificationsForBudgetRequest$BudgetName' => 'The name of the budget whose notifications you want descriptions of.
', 'DescribeSubscribersForNotificationRequest$BudgetName' => 'The name of the budget whose subscribers you want descriptions of.
', 'ExecuteBudgetActionRequest$BudgetName' => NULL, 'ExecuteBudgetActionResponse$BudgetName' => NULL, 'UpdateBudgetActionRequest$BudgetName' => NULL, 'UpdateBudgetActionResponse$BudgetName' => NULL, 'UpdateNotificationRequest$BudgetName' => 'The name of the budget whose notification you want to update.
', 'UpdateSubscriberRequest$BudgetName' => 'The name of the budget whose subscriber you want to update.
', ], ], 'BudgetNotificationsForAccount' => [ 'base' => 'The budget name and associated notifications for an account.
', 'refs' => [ 'BudgetNotificationsForAccountList$member' => NULL, ], ], 'BudgetNotificationsForAccountList' => [ 'base' => NULL, 'refs' => [ 'DescribeBudgetNotificationsForAccountResponse$BudgetNotificationsForAccount' => 'A list of budget names and associated notifications for an account.
', ], ], 'BudgetPerformanceHistory' => [ 'base' => 'A history of the state of a budget at the end of the budget\'s specified time period.
', 'refs' => [ 'DescribeBudgetPerformanceHistoryResponse$BudgetPerformanceHistory' => 'The history of how often the budget has gone into an ALARM state.
For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters.
The type of a budget. It must be one of the following types:
COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.
Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
', 'BudgetPerformanceHistory$BudgetType' => NULL, ], ], 'BudgetedAndActualAmounts' => [ 'base' => 'The amount of cost or usage that you created the budget for, compared to your actual costs or usage.
', 'refs' => [ 'BudgetedAndActualAmountsList$member' => NULL, ], ], 'BudgetedAndActualAmountsList' => [ 'base' => NULL, 'refs' => [ 'BudgetPerformanceHistory$BudgetedAndActualAmountsList' => 'A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.
', ], ], 'Budgets' => [ 'base' => 'A list of budgets.
', 'refs' => [ 'DescribeBudgetsResponse$Budgets' => 'A list of budgets.
', ], ], 'CalculatedSpend' => [ 'base' => 'The spend objects that are associated with this budget. The actualSpend tracks how much you\'ve used, cost, usage, RI units, or Savings Plans units and the forecastedSpend tracks how much that you\'re predicted to spend based on your historical usage profile.
For example, if it\'s the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.
The actual and forecasted cost or usage that the budget tracks.
', ], ], 'ComparisonOperator' => [ 'base' => 'The comparison operator of a notification. Currently, the service supports the following operators:
GREATER_THAN, LESS_THAN, EQUAL_TO
The comparison that\'s used for this notification.
', ], ], 'CostFilters' => [ 'base' => 'A map that represents the cost filters that are applied to the budget.
', 'refs' => [ 'Budget$CostFilters' => 'The cost filters, such as Region, Service, member account, Tag, or Cost Category, that are applied to a budget.
Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:
Amazon EC2
Amazon Redshift
Amazon Relational Database Service
Amazon ElastiCache
Amazon OpenSearch Service
The history of the cost filters for a budget during the specified time period.
', ], ], 'CostTypes' => [ 'base' => 'The types of cost that are included in a COST budget, such as tax and subscriptions.
USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets don\'t have CostTypes.
The types of costs that are included in this COST budget.
USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.
The history of the cost types for a budget during the specified time period.
', ], ], 'CreateBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateBudgetRequest' => [ 'base' => 'Request of CreateBudget
', 'refs' => [], ], 'CreateBudgetResponse' => [ 'base' => 'Response of CreateBudget
', 'refs' => [], ], 'CreateNotificationRequest' => [ 'base' => 'Request of CreateNotification
', 'refs' => [], ], 'CreateNotificationResponse' => [ 'base' => 'Response of CreateNotification
', 'refs' => [], ], 'CreateSubscriberRequest' => [ 'base' => 'Request of CreateSubscriber
', 'refs' => [], ], 'CreateSubscriberResponse' => [ 'base' => 'Response of CreateSubscriber
', 'refs' => [], ], 'CreationLimitExceededException' => [ 'base' => 'You\'ve exceeded the notification or subscriber limit.
', 'refs' => [], ], 'Definition' => [ 'base' => 'Specifies all of the type-specific parameters.
', 'refs' => [ 'Action$Definition' => 'Where you specify all of the type-specific parameters.
', 'CreateBudgetActionRequest$Definition' => NULL, 'UpdateBudgetActionRequest$Definition' => NULL, ], ], 'DeleteBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBudgetRequest' => [ 'base' => 'Request of DeleteBudget
', 'refs' => [], ], 'DeleteBudgetResponse' => [ 'base' => 'Response of DeleteBudget
', 'refs' => [], ], 'DeleteNotificationRequest' => [ 'base' => 'Request of DeleteNotification
', 'refs' => [], ], 'DeleteNotificationResponse' => [ 'base' => 'Response of DeleteNotification
', 'refs' => [], ], 'DeleteSubscriberRequest' => [ 'base' => 'Request of DeleteSubscriber
', 'refs' => [], ], 'DeleteSubscriberResponse' => [ 'base' => 'Response of DeleteSubscriber
', 'refs' => [], ], 'DescribeBudgetActionHistoriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionHistoriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionsForAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionsForAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionsForBudgetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionsForBudgetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetNotificationsForAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetNotificationsForAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetPerformanceHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetPerformanceHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetRequest' => [ 'base' => 'Request of DescribeBudget
', 'refs' => [], ], 'DescribeBudgetResponse' => [ 'base' => 'Response of DescribeBudget
', 'refs' => [], ], 'DescribeBudgetsRequest' => [ 'base' => 'Request of DescribeBudgets
', 'refs' => [], ], 'DescribeBudgetsResponse' => [ 'base' => 'Response of DescribeBudgets
', 'refs' => [], ], 'DescribeNotificationsForBudgetRequest' => [ 'base' => 'Request of DescribeNotificationsForBudget
', 'refs' => [], ], 'DescribeNotificationsForBudgetResponse' => [ 'base' => 'Response of GetNotificationsForBudget
', 'refs' => [], ], 'DescribeSubscribersForNotificationRequest' => [ 'base' => 'Request of DescribeSubscribersForNotification
', 'refs' => [], ], 'DescribeSubscribersForNotificationResponse' => [ 'base' => 'Response of DescribeSubscribersForNotification
', 'refs' => [], ], 'DimensionValue' => [ 'base' => NULL, 'refs' => [ 'DimensionValues$member' => NULL, ], ], 'DimensionValues' => [ 'base' => NULL, 'refs' => [ 'CostFilters$value' => NULL, ], ], 'DuplicateRecordException' => [ 'base' => 'The budget name already exists. Budget names must be unique within an account.
', 'refs' => [], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'ActionHistory$EventType' => 'This distinguishes between whether the events are triggered by the user or are generated by the system.
', ], ], 'ExecuteBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ExecutionType' => [ 'base' => NULL, 'refs' => [ 'ExecuteBudgetActionRequest$ExecutionType' => 'The type of execution.
', 'ExecuteBudgetActionResponse$ExecutionType' => 'The type of execution.
', ], ], 'ExpiredNextTokenException' => [ 'base' => 'The pagination token expired.
', 'refs' => [], ], 'GenericString' => [ 'base' => 'A generic string.
', 'refs' => [ 'ActionHistoryDetails$Message' => NULL, 'CostFilters$key' => NULL, 'DescribeBudgetActionHistoriesRequest$NextToken' => NULL, 'DescribeBudgetActionHistoriesResponse$NextToken' => NULL, 'DescribeBudgetActionsForAccountRequest$NextToken' => NULL, 'DescribeBudgetActionsForAccountResponse$NextToken' => NULL, 'DescribeBudgetActionsForBudgetRequest$NextToken' => NULL, 'DescribeBudgetActionsForBudgetResponse$NextToken' => NULL, 'DescribeBudgetNotificationsForAccountRequest$NextToken' => NULL, 'DescribeBudgetNotificationsForAccountResponse$NextToken' => NULL, 'DescribeBudgetPerformanceHistoryRequest$NextToken' => NULL, 'DescribeBudgetPerformanceHistoryResponse$NextToken' => NULL, 'DescribeBudgetsRequest$NextToken' => 'The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
', 'DescribeBudgetsResponse$NextToken' => 'The pagination token in the service response that indicates the next set of results that you can retrieve.
', 'DescribeNotificationsForBudgetRequest$NextToken' => 'The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
', 'DescribeNotificationsForBudgetResponse$NextToken' => 'The pagination token in the service response that indicates the next set of results that you can retrieve.
', 'DescribeSubscribersForNotificationRequest$NextToken' => 'The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
', 'DescribeSubscribersForNotificationResponse$NextToken' => 'The pagination token in the service response that indicates the next set of results that you can retrieve.
', 'PlannedBudgetLimits$key' => NULL, ], ], 'GenericTimestamp' => [ 'base' => ' A generic time stamp. In Java, it\'s transformed to a Date object.
The last time that your budget was auto-adjusted.
', 'Budget$LastUpdatedTime' => 'The last time that you updated this budget.
', 'TimePeriod$Start' => 'The start date for a budget. If you created your budget and didn\'t specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn\'t set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget operation.
The end date for a budget. If you didn\'t specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.
A list of groups to be attached. There must be at least one group.
', ], ], 'HistoricalOptions' => [ 'base' => 'The parameters that define or describe the historical data that your auto-adjusting budget is based on.
', 'refs' => [ 'AutoAdjustData$HistoricalOptions' => 'The parameters that define or describe the historical data that your auto-adjusting budget is based on.
', ], ], 'IamActionDefinition' => [ 'base' => 'The Identity and Access Management (IAM) action definition details.
', 'refs' => [ 'Definition$IamActionDefinition' => 'The Identity and Access Management (IAM) action definition details.
', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'InstanceIds$member' => NULL, ], ], 'InstanceIds' => [ 'base' => NULL, 'refs' => [ 'SsmActionDefinition$InstanceIds' => 'The EC2 and RDS instance IDs.
', ], ], 'InternalErrorException' => [ 'base' => 'An error on the server occurred during the processing of your request. Try again later.
', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => 'The pagination token is invalid.
', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => 'An error on the client occurred. Typically, the cause is an invalid input value.
', 'refs' => [], ], 'MaxResults' => [ 'base' => 'An integer that represents how many entries a paginated response contains. The maximum is 100.
', 'refs' => [ 'DescribeBudgetActionHistoriesRequest$MaxResults' => NULL, 'DescribeBudgetActionsForAccountRequest$MaxResults' => NULL, 'DescribeBudgetActionsForBudgetRequest$MaxResults' => NULL, 'DescribeBudgetPerformanceHistoryRequest$MaxResults' => NULL, 'DescribeBudgetsRequest$MaxResults' => 'An optional integer that represents how many entries a paginated response contains. The maximum is 100.
', 'DescribeNotificationsForBudgetRequest$MaxResults' => 'An optional integer that represents how many entries a paginated response contains. The maximum is 100.
', 'DescribeSubscribersForNotificationRequest$MaxResults' => 'An optional integer that represents how many entries a paginated response contains. The maximum is 100.
', ], ], 'MaxResultsBudgetNotifications' => [ 'base' => NULL, 'refs' => [ 'DescribeBudgetNotificationsForAccountRequest$MaxResults' => 'An integer that shows how many budget name entries a paginated response contains.
', ], ], 'NotFoundException' => [ 'base' => 'We can’t locate the resource that you specified.
', 'refs' => [], ], 'Notification' => [ 'base' => 'A notification that\'s associated with a budget. A budget can have up to ten notifications.
Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:
A notificationType of ACTUAL
A thresholdType of PERCENTAGE
A comparisonOperator of GREATER_THAN
A notification threshold of 80
The notification that you want to create.
', 'CreateSubscriberRequest$Notification' => 'The notification that you want to create a subscriber for.
', 'DeleteNotificationRequest$Notification' => 'The notification that you want to delete.
', 'DeleteSubscriberRequest$Notification' => 'The notification whose subscriber you want to delete.
', 'DescribeSubscribersForNotificationRequest$Notification' => 'The notification whose subscribers you want to list.
', 'NotificationWithSubscribers$Notification' => 'The notification that\'s associated with a budget.
', 'Notifications$member' => NULL, 'UpdateNotificationRequest$OldNotification' => 'The previous notification that is associated with a budget.
', 'UpdateNotificationRequest$NewNotification' => 'The updated notification to be associated with a budget.
', 'UpdateSubscriberRequest$Notification' => 'The notification whose subscriber you want to update.
', ], ], 'NotificationState' => [ 'base' => NULL, 'refs' => [ 'Notification$NotificationState' => 'Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.
The threshold of a notification.
', 'refs' => [ 'ActionThreshold$ActionThresholdValue' => NULL, 'Notification$Threshold' => 'The threshold that\'s associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.
', ], ], 'NotificationType' => [ 'base' => 'The type of a notification. It must be ACTUAL or FORECASTED.
', 'refs' => [ 'Action$NotificationType' => NULL, 'CreateBudgetActionRequest$NotificationType' => NULL, 'Notification$NotificationType' => 'Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you\'re forecasted to spend (FORECASTED).
A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
', 'refs' => [ 'NotificationWithSubscribersList$member' => NULL, ], ], 'NotificationWithSubscribersList' => [ 'base' => 'A list of notifications, each with a list of subscribers.
', 'refs' => [ 'CreateBudgetRequest$NotificationsWithSubscribers' => 'A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, Amazon Web Services creates the notifications and subscribers for you.
A list of notifications.
', 'refs' => [ 'BudgetNotificationsForAccount$Notifications' => NULL, 'DescribeNotificationsForBudgetResponse$Notifications' => 'A list of notifications that are associated with a budget.
', ], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'CostTypes$IncludeTax' => 'Specifies whether a budget includes taxes.
The default value is true.
Specifies whether a budget includes subscriptions.
The default value is true.
Specifies whether a budget uses a blended rate.
The default value is false.
Specifies whether a budget includes refunds.
The default value is true.
Specifies whether a budget includes credits.
The default value is true.
Specifies whether a budget includes upfront RI costs.
The default value is true.
Specifies whether a budget includes recurring fees such as monthly RI fees.
The default value is true.
Specifies whether a budget includes non-RI subscription costs.
The default value is true.
Specifies whether a budget includes support subscription fees.
The default value is true.
Specifies whether a budget includes discounts.
The default value is true.
Specifies whether a budget uses the amortized rate.
The default value is false.
A string that represents a numeric value.
', 'refs' => [ 'Spend$Amount' => 'The cost or usage amount that\'s associated with a budget forecast, actual spend, or budget threshold.
', ], ], 'PlannedBudgetLimits' => [ 'base' => NULL, 'refs' => [ 'Budget$PlannedBudgetLimits' => 'A map containing multiple BudgetLimit, including current or future limits.
PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit.
For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.
For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the start of the quarter, UTC in epoch seconds.
If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.
If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.
After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.
DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets that are created with PlannedBudgetLimits. Budgets that are created without PlannedBudgetLimits only contain BudgetLimit. They don\'t contain PlannedBudgetLimits.
The Amazon Resource Name (ARN) of the policy to be attached.
', ], ], 'PolicyId' => [ 'base' => NULL, 'refs' => [ 'ScpActionDefinition$PolicyId' => 'The policy ID attached.
', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'SsmActionDefinition$Region' => 'The Region to run the SSM document.
', ], ], 'ResourceLockedException' => [ 'base' => 'The request was received and recognized by the server, but the server rejected that particular method for the requested resource.
', 'refs' => [], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'Roles$member' => NULL, ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'Action$ExecutionRoleArn' => 'The role passed for action execution and reversion. Roles and actions must be in the same account.
', 'CreateBudgetActionRequest$ExecutionRoleArn' => 'The role passed for action execution and reversion. Roles and actions must be in the same account.
', 'UpdateBudgetActionRequest$ExecutionRoleArn' => 'The role passed for action execution and reversion. Roles and actions must be in the same account.
', ], ], 'Roles' => [ 'base' => NULL, 'refs' => [ 'IamActionDefinition$Roles' => 'A list of roles to be attached. There must be at least one role.
', ], ], 'ScpActionDefinition' => [ 'base' => 'The service control policies (SCP) action definition details.
', 'refs' => [ 'Definition$ScpActionDefinition' => 'The service control policies (SCPs) action definition details.
', ], ], 'Spend' => [ 'base' => 'The amount of cost or usage that\'s measured for a budget.
For example, a Spend for 3 GB of S3 usage has the following parameters:
An Amount of 3
A unit of GB
The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.
BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can\'t use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.
The amount of cost or usage that you created the budget for.
', 'BudgetedAndActualAmounts$ActualAmount' => 'Your actual costs or usage for a budget period.
', 'CalculatedSpend$ActualSpend' => 'The amount of cost, usage, RI units, or Savings Plans units that you used.
', 'CalculatedSpend$ForecastedSpend' => 'The amount of cost, usage, RI units, or Savings Plans units that you\'re forecasted to use.
', 'PlannedBudgetLimits$value' => NULL, ], ], 'SsmActionDefinition' => [ 'base' => 'The Amazon Web Services Systems Manager (SSM) action definition details.
', 'refs' => [ 'Definition$SsmActionDefinition' => 'The Amazon Web Services Systems Manager (SSM) action definition details.
', ], ], 'Subscriber' => [ 'base' => 'The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
For example, an email subscriber has the following parameters:
A subscriptionType of EMAIL
An address of example@example.com
The subscriber that you want to associate with a budget notification.
', 'DeleteSubscriberRequest$Subscriber' => 'The subscriber that you want to delete.
', 'Subscribers$member' => NULL, 'UpdateSubscriberRequest$OldSubscriber' => 'The previous subscriber that is associated with a budget notification.
', 'UpdateSubscriberRequest$NewSubscriber' => 'The updated subscriber that is associated with a budget notification.
', ], ], 'SubscriberAddress' => [ 'base' => 'A string that contains an email address or SNS topic for the subscriber\'s address.
', 'refs' => [ 'Subscriber$Address' => 'The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.
When you create a subscriber, the value of Address can\'t contain line breaks.
A list of subscribers.
', 'refs' => [ 'Action$Subscribers' => NULL, 'CreateBudgetActionRequest$Subscribers' => NULL, 'CreateNotificationRequest$Subscribers' => 'A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.
', 'DescribeSubscribersForNotificationResponse$Subscribers' => 'A list of subscribers that are associated with a notification.
', 'NotificationWithSubscribers$Subscribers' => 'A list of subscribers who are subscribed to this notification.
', 'UpdateBudgetActionRequest$Subscribers' => NULL, ], ], 'SubscriptionType' => [ 'base' => 'The subscription type of the subscriber. It can be SMS or EMAIL.
', 'refs' => [ 'Subscriber$SubscriptionType' => 'The type of notification that Amazon Web Services sends to a subscriber.
', ], ], 'TargetId' => [ 'base' => NULL, 'refs' => [ 'TargetIds$member' => NULL, ], ], 'TargetIds' => [ 'base' => NULL, 'refs' => [ 'ScpActionDefinition$TargetIds' => 'A list of target IDs.
', ], ], 'ThresholdType' => [ 'base' => 'The type of threshold for a notification.
', 'refs' => [ 'ActionThreshold$ActionThresholdType' => NULL, 'Notification$ThresholdType' => 'The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
', 'refs' => [], ], 'TimePeriod' => [ 'base' => 'The period of time that\'s covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
', 'refs' => [ 'Budget$TimePeriod' => 'The period of time that\'s covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.
If you create your budget and don\'t specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn\'t set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. If you didn\'t specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.
You can change either date with the UpdateBudget operation.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
', 'BudgetedAndActualAmounts$TimePeriod' => 'The time period that\'s covered by this budget comparison.
', 'DescribeBudgetActionHistoriesRequest$TimePeriod' => NULL, 'DescribeBudgetPerformanceHistoryRequest$TimePeriod' => 'Retrieves how often the budget went into an ALARM state for the specified time period.
The time unit of the budget, such as MONTHLY or QUARTERLY.
', 'refs' => [ 'Budget$TimeUnit' => 'The length of time until a budget resets the actual and forecasted spend.
', 'BudgetPerformanceHistory$TimeUnit' => NULL, ], ], 'UnitValue' => [ 'base' => 'A string that represents the spend unit of a budget. It can\'t be null or empty.
', 'refs' => [ 'Spend$Unit' => 'The unit of measurement that\'s used for the budget forecast, actual spend, or budget threshold, such as USD or GBP.
', ], ], 'UpdateBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBudgetRequest' => [ 'base' => 'Request of UpdateBudget
', 'refs' => [], ], 'UpdateBudgetResponse' => [ 'base' => 'Response of UpdateBudget
', 'refs' => [], ], 'UpdateNotificationRequest' => [ 'base' => 'Request of UpdateNotification
', 'refs' => [], ], 'UpdateNotificationResponse' => [ 'base' => 'Response of UpdateNotification
', 'refs' => [], ], 'UpdateSubscriberRequest' => [ 'base' => 'Request of UpdateSubscriber
', 'refs' => [], ], 'UpdateSubscriberResponse' => [ 'base' => 'Response of UpdateSubscriber
', 'refs' => [], ], 'User' => [ 'base' => NULL, 'refs' => [ 'Users$member' => NULL, ], ], 'Users' => [ 'base' => NULL, 'refs' => [ 'IamActionDefinition$Users' => 'A list of users to be attached. There must be at least one user.
', ], ], 'errorMessage' => [ 'base' => 'The error message the exception carries.
', 'refs' => [ 'AccessDeniedException$Message' => NULL, 'CreationLimitExceededException$Message' => NULL, 'DuplicateRecordException$Message' => NULL, 'ExpiredNextTokenException$Message' => NULL, 'InternalErrorException$Message' => NULL, 'InvalidNextTokenException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'NotFoundException$Message' => NULL, 'ResourceLockedException$Message' => NULL, 'ThrottlingException$Message' => NULL, ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.
Budgets provide you with a way to see the following information:
How close your plan is to your budgeted amount or to the free tier limits
Your usage-to-date, including how much you\'ve used of your Reserved Instances (RIs)
Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
How much of your budget has been used
Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:
Cost budgets - Plan how much you want to spend on a service.
Usage budgets - Plan how much you want to use one or more services.
RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.
RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.
Service Endpoint
The Amazon Web Services Budgets API provides the following endpoint:
https://budgets.amazonaws.com
For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
', 'operations' => [ 'CreateBudget' => 'Creates a budget and, if included, notifications and subscribers.
Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Creates a budget action.
', 'CreateNotification' => 'Creates a notification. You must create the budget before you create the associated notification.
', 'CreateSubscriber' => 'Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
', 'DeleteBudget' => 'Deletes a budget. You can delete your budget at any time.
Deleting a budget also deletes the notifications and subscribers that are associated with that budget.
Deletes a budget action.
', 'DeleteNotification' => 'Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
Describes a budget.
The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Describes a budget action detail.
', 'DescribeBudgetActionHistories' => 'Describes a budget action history detail.
', 'DescribeBudgetActionsForAccount' => 'Describes all of the budget actions for an account.
', 'DescribeBudgetActionsForBudget' => 'Describes all of the budget actions for a budget.
', 'DescribeBudgetNotificationsForAccount' => 'Lists the budget names and notifications that are associated with an account.
', 'DescribeBudgetPerformanceHistory' => 'Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn\'t available for ANNUAL budgets.
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Lists the notifications that are associated with a budget.
', 'DescribeSubscribersForNotification' => 'Lists the subscribers that are associated with a notification.
', 'ExecuteBudgetAction' => 'Executes a budget action.
', 'UpdateBudget' => 'Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until Amazon Web Services has new usage data to use for forecasting.
Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Updates a budget action.
', 'UpdateNotification' => 'Updates a notification.
', 'UpdateSubscriber' => 'Updates a subscriber.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You are not authorized to use this operation with the given parameters.
', 'refs' => [], ], 'AccountId' => [ 'base' => 'The account ID of the user. It\'s a 12-digit number.
', 'refs' => [ 'CreateBudgetActionRequest$AccountId' => NULL, 'CreateBudgetActionResponse$AccountId' => NULL, 'CreateBudgetRequest$AccountId' => 'The accountId that is associated with the budget.
The accountId that is associated with the budget that you want to create a notification for.
The accountId that is associated with the budget that you want to create a subscriber for.
The accountId that is associated with the budget that you want to delete.
The accountId that is associated with the budget whose notification you want to delete.
The accountId that is associated with the budget whose subscriber you want to delete.
The accountId that is associated with the budget that you want a description of.
The accountId that is associated with the budgets that you want descriptions of.
The accountId that is associated with the budget whose notifications you want descriptions of.
The accountId that is associated with the budget whose subscribers you want descriptions of.
The accountId that is associated with the budget that you want to update.
The accountId that is associated with the budget whose notification you want to update.
The accountId that is associated with the budget whose subscriber you want to update.
A budget action resource.
', 'refs' => [ 'ActionHistoryDetails$Action' => 'The budget action resource.
', 'Actions$member' => NULL, 'DeleteBudgetActionResponse$Action' => NULL, 'DescribeBudgetActionResponse$Action' => 'A budget action resource.
', 'UpdateBudgetActionResponse$OldAction' => 'The previous action resource information.
', 'UpdateBudgetActionResponse$NewAction' => 'The updated action resource information.
', ], ], 'ActionHistories' => [ 'base' => NULL, 'refs' => [ 'DescribeBudgetActionHistoriesResponse$ActionHistories' => 'The historical record of the budget action resource.
', ], ], 'ActionHistory' => [ 'base' => 'The historical records for a budget action.
', 'refs' => [ 'ActionHistories$member' => NULL, ], ], 'ActionHistoryDetails' => [ 'base' => 'The description of the details for the event.
', 'refs' => [ 'ActionHistory$ActionHistoryDetails' => 'The description of the details for the event.
', ], ], 'ActionId' => [ 'base' => NULL, 'refs' => [ 'Action$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'CreateBudgetActionResponse$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'DeleteBudgetActionRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'DescribeBudgetActionHistoriesRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'DescribeBudgetActionRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'ExecuteBudgetActionRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'ExecuteBudgetActionResponse$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', 'UpdateBudgetActionRequest$ActionId' => 'A system-generated universally unique identifier (UUID) for the action.
', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'Action$Status' => 'The status of the action.
', 'ActionHistory$Status' => 'The status of action at the time of the event.
', ], ], 'ActionSubType' => [ 'base' => NULL, 'refs' => [ 'SsmActionDefinition$ActionSubType' => 'The action subType.
', ], ], 'ActionThreshold' => [ 'base' => 'The trigger threshold of the action.
', 'refs' => [ 'Action$ActionThreshold' => 'The trigger threshold of the action.
', 'CreateBudgetActionRequest$ActionThreshold' => NULL, 'UpdateBudgetActionRequest$ActionThreshold' => NULL, ], ], 'ActionType' => [ 'base' => NULL, 'refs' => [ 'Action$ActionType' => 'The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.
', 'CreateBudgetActionRequest$ActionType' => 'The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.
', ], ], 'Actions' => [ 'base' => NULL, 'refs' => [ 'DescribeBudgetActionsForAccountResponse$Actions' => 'A list of the budget action resources information.
', 'DescribeBudgetActionsForBudgetResponse$Actions' => 'A list of the budget action resources information.
', ], ], 'AdjustmentPeriod' => [ 'base' => NULL, 'refs' => [ 'HistoricalOptions$BudgetAdjustmentPeriod' => 'The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:
For the DAILY granularity, the maximum value is 60.
For the MONTHLY granularity, the maximum value is 12.
For the QUARTERLY granularity, the maximum value is 4.
For the ANNUALLY granularity, the maximum value is 1.
The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.
For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.
You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.
This specifies if the action needs manual or automatic approval.
', 'CreateBudgetActionRequest$ApprovalModel' => 'This specifies if the action needs manual or automatic approval.
', 'UpdateBudgetActionRequest$ApprovalModel' => 'This specifies if the action needs manual or automatic approval.
', ], ], 'AutoAdjustData' => [ 'base' => 'The parameters that determine the budget amount for an auto-adjusting budget.
', 'refs' => [ 'Budget$AutoAdjustData' => 'The parameters that determine the budget amount for an auto-adjusting budget.
', ], ], 'AutoAdjustType' => [ 'base' => NULL, 'refs' => [ 'AutoAdjustData$AutoAdjustType' => 'The string that defines whether your budget auto-adjusts based on historical or forecasted data.
', ], ], 'Budget' => [ 'base' => 'Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.
This is the Amazon Resource Name (ARN) pattern for a budget:
arn:aws:budgets::AccountId:budget/budgetName
The budget object that you want to create.
', 'DescribeBudgetResponse$Budget' => 'The description of the budget.
', 'UpdateBudgetRequest$NewBudget' => 'The budget that you want to update your budget to.
', ], ], 'BudgetName' => [ 'base' => 'A string that represents the budget name. The ":" and "\\" characters, and the "/action/" substring, aren\'t allowed.
', 'refs' => [ 'Action$BudgetName' => NULL, 'Budget$BudgetName' => 'The name of a budget. The name must be unique within an account. The : and \\ characters, and the "/action/" substring, aren\'t allowed in BudgetName.
The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.
', 'CreateSubscriberRequest$BudgetName' => 'The name of the budget that you want to subscribe to. Budget names must be unique within an account.
', 'DeleteBudgetActionRequest$BudgetName' => NULL, 'DeleteBudgetActionResponse$BudgetName' => NULL, 'DeleteBudgetRequest$BudgetName' => 'The name of the budget that you want to delete.
', 'DeleteNotificationRequest$BudgetName' => 'The name of the budget whose notification you want to delete.
', 'DeleteSubscriberRequest$BudgetName' => 'The name of the budget whose subscriber you want to delete.
', 'DescribeBudgetActionHistoriesRequest$BudgetName' => NULL, 'DescribeBudgetActionRequest$BudgetName' => NULL, 'DescribeBudgetActionResponse$BudgetName' => NULL, 'DescribeBudgetActionsForBudgetRequest$BudgetName' => NULL, 'DescribeBudgetPerformanceHistoryRequest$BudgetName' => NULL, 'DescribeBudgetRequest$BudgetName' => 'The name of the budget that you want a description of.
', 'DescribeNotificationsForBudgetRequest$BudgetName' => 'The name of the budget whose notifications you want descriptions of.
', 'DescribeSubscribersForNotificationRequest$BudgetName' => 'The name of the budget whose subscribers you want descriptions of.
', 'ExecuteBudgetActionRequest$BudgetName' => NULL, 'ExecuteBudgetActionResponse$BudgetName' => NULL, 'UpdateBudgetActionRequest$BudgetName' => NULL, 'UpdateBudgetActionResponse$BudgetName' => NULL, 'UpdateNotificationRequest$BudgetName' => 'The name of the budget whose notification you want to update.
', 'UpdateSubscriberRequest$BudgetName' => 'The name of the budget whose subscriber you want to update.
', ], ], 'BudgetNotificationsForAccount' => [ 'base' => 'The budget name and associated notifications for an account.
', 'refs' => [ 'BudgetNotificationsForAccountList$member' => NULL, ], ], 'BudgetNotificationsForAccountList' => [ 'base' => NULL, 'refs' => [ 'DescribeBudgetNotificationsForAccountResponse$BudgetNotificationsForAccount' => 'A list of budget names and associated notifications for an account.
', ], ], 'BudgetPerformanceHistory' => [ 'base' => 'A history of the state of a budget at the end of the budget\'s specified time period.
', 'refs' => [ 'DescribeBudgetPerformanceHistoryResponse$BudgetPerformanceHistory' => 'The history of how often the budget has gone into an ALARM state.
For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters.
The type of a budget. It must be one of the following types:
COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.
Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
', 'BudgetPerformanceHistory$BudgetType' => NULL, ], ], 'BudgetedAndActualAmounts' => [ 'base' => 'The amount of cost or usage that you created the budget for, compared to your actual costs or usage.
', 'refs' => [ 'BudgetedAndActualAmountsList$member' => NULL, ], ], 'BudgetedAndActualAmountsList' => [ 'base' => NULL, 'refs' => [ 'BudgetPerformanceHistory$BudgetedAndActualAmountsList' => 'A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.
', ], ], 'Budgets' => [ 'base' => 'A list of budgets.
', 'refs' => [ 'DescribeBudgetsResponse$Budgets' => 'A list of budgets.
', ], ], 'CalculatedSpend' => [ 'base' => 'The spend objects that are associated with this budget. The actualSpend tracks how much you\'ve used, cost, usage, RI units, or Savings Plans units and the forecastedSpend tracks how much that you\'re predicted to spend based on your historical usage profile.
For example, if it\'s the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.
The actual and forecasted cost or usage that the budget tracks.
', ], ], 'ComparisonOperator' => [ 'base' => 'The comparison operator of a notification. Currently, the service supports the following operators:
GREATER_THAN, LESS_THAN, EQUAL_TO
The comparison that\'s used for this notification.
', ], ], 'CostFilters' => [ 'base' => 'A map that represents the cost filters that are applied to the budget.
', 'refs' => [ 'Budget$CostFilters' => 'The cost filters, such as Region, Service, member account, Tag, or Cost Category, that are applied to a budget.
Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:
Amazon EC2
Amazon Redshift
Amazon Relational Database Service
Amazon ElastiCache
Amazon OpenSearch Service
The history of the cost filters for a budget during the specified time period.
', ], ], 'CostTypes' => [ 'base' => 'The types of cost that are included in a COST budget, such as tax and subscriptions.
USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets don\'t have CostTypes.
The types of costs that are included in this COST budget.
USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.
The history of the cost types for a budget during the specified time period.
', ], ], 'CreateBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateBudgetRequest' => [ 'base' => 'Request of CreateBudget
', 'refs' => [], ], 'CreateBudgetResponse' => [ 'base' => 'Response of CreateBudget
', 'refs' => [], ], 'CreateNotificationRequest' => [ 'base' => 'Request of CreateNotification
', 'refs' => [], ], 'CreateNotificationResponse' => [ 'base' => 'Response of CreateNotification
', 'refs' => [], ], 'CreateSubscriberRequest' => [ 'base' => 'Request of CreateSubscriber
', 'refs' => [], ], 'CreateSubscriberResponse' => [ 'base' => 'Response of CreateSubscriber
', 'refs' => [], ], 'CreationLimitExceededException' => [ 'base' => 'You\'ve exceeded the notification or subscriber limit.
', 'refs' => [], ], 'Definition' => [ 'base' => 'Specifies all of the type-specific parameters.
', 'refs' => [ 'Action$Definition' => 'Where you specify all of the type-specific parameters.
', 'CreateBudgetActionRequest$Definition' => NULL, 'UpdateBudgetActionRequest$Definition' => NULL, ], ], 'DeleteBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBudgetRequest' => [ 'base' => 'Request of DeleteBudget
', 'refs' => [], ], 'DeleteBudgetResponse' => [ 'base' => 'Response of DeleteBudget
', 'refs' => [], ], 'DeleteNotificationRequest' => [ 'base' => 'Request of DeleteNotification
', 'refs' => [], ], 'DeleteNotificationResponse' => [ 'base' => 'Response of DeleteNotification
', 'refs' => [], ], 'DeleteSubscriberRequest' => [ 'base' => 'Request of DeleteSubscriber
', 'refs' => [], ], 'DeleteSubscriberResponse' => [ 'base' => 'Response of DeleteSubscriber
', 'refs' => [], ], 'DescribeBudgetActionHistoriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionHistoriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionsForAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionsForAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionsForBudgetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetActionsForBudgetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetNotificationsForAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetNotificationsForAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetPerformanceHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetPerformanceHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBudgetRequest' => [ 'base' => 'Request of DescribeBudget
', 'refs' => [], ], 'DescribeBudgetResponse' => [ 'base' => 'Response of DescribeBudget
', 'refs' => [], ], 'DescribeBudgetsRequest' => [ 'base' => 'Request of DescribeBudgets
', 'refs' => [], ], 'DescribeBudgetsResponse' => [ 'base' => 'Response of DescribeBudgets
', 'refs' => [], ], 'DescribeNotificationsForBudgetRequest' => [ 'base' => 'Request of DescribeNotificationsForBudget
', 'refs' => [], ], 'DescribeNotificationsForBudgetResponse' => [ 'base' => 'Response of GetNotificationsForBudget
', 'refs' => [], ], 'DescribeSubscribersForNotificationRequest' => [ 'base' => 'Request of DescribeSubscribersForNotification
', 'refs' => [], ], 'DescribeSubscribersForNotificationResponse' => [ 'base' => 'Response of DescribeSubscribersForNotification
', 'refs' => [], ], 'DimensionValue' => [ 'base' => NULL, 'refs' => [ 'DimensionValues$member' => NULL, ], ], 'DimensionValues' => [ 'base' => NULL, 'refs' => [ 'CostFilters$value' => NULL, ], ], 'DuplicateRecordException' => [ 'base' => 'The budget name already exists. Budget names must be unique within an account.
', 'refs' => [], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'ActionHistory$EventType' => 'This distinguishes between whether the events are triggered by the user or are generated by the system.
', ], ], 'ExecuteBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ExecutionType' => [ 'base' => NULL, 'refs' => [ 'ExecuteBudgetActionRequest$ExecutionType' => 'The type of execution.
', 'ExecuteBudgetActionResponse$ExecutionType' => 'The type of execution.
', ], ], 'ExpiredNextTokenException' => [ 'base' => 'The pagination token expired.
', 'refs' => [], ], 'GenericString' => [ 'base' => 'A generic string.
', 'refs' => [ 'ActionHistoryDetails$Message' => NULL, 'CostFilters$key' => NULL, 'DescribeBudgetActionHistoriesRequest$NextToken' => NULL, 'DescribeBudgetActionHistoriesResponse$NextToken' => NULL, 'DescribeBudgetActionsForAccountRequest$NextToken' => NULL, 'DescribeBudgetActionsForAccountResponse$NextToken' => NULL, 'DescribeBudgetActionsForBudgetRequest$NextToken' => NULL, 'DescribeBudgetActionsForBudgetResponse$NextToken' => NULL, 'DescribeBudgetNotificationsForAccountRequest$NextToken' => NULL, 'DescribeBudgetNotificationsForAccountResponse$NextToken' => NULL, 'DescribeBudgetPerformanceHistoryRequest$NextToken' => NULL, 'DescribeBudgetPerformanceHistoryResponse$NextToken' => NULL, 'DescribeBudgetsRequest$NextToken' => 'The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
', 'DescribeBudgetsResponse$NextToken' => 'The pagination token in the service response that indicates the next set of results that you can retrieve.
', 'DescribeNotificationsForBudgetRequest$NextToken' => 'The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
', 'DescribeNotificationsForBudgetResponse$NextToken' => 'The pagination token in the service response that indicates the next set of results that you can retrieve.
', 'DescribeSubscribersForNotificationRequest$NextToken' => 'The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
', 'DescribeSubscribersForNotificationResponse$NextToken' => 'The pagination token in the service response that indicates the next set of results that you can retrieve.
', 'PlannedBudgetLimits$key' => NULL, ], ], 'GenericTimestamp' => [ 'base' => ' A generic time stamp. In Java, it\'s transformed to a Date object.
The last time that your budget was auto-adjusted.
', 'Budget$LastUpdatedTime' => 'The last time that you updated this budget.
', 'TimePeriod$Start' => 'The start date for a budget. If you created your budget and didn\'t specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn\'t set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget operation.
The end date for a budget. If you didn\'t specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.
A list of groups to be attached. There must be at least one group.
', ], ], 'HistoricalOptions' => [ 'base' => 'The parameters that define or describe the historical data that your auto-adjusting budget is based on.
', 'refs' => [ 'AutoAdjustData$HistoricalOptions' => 'The parameters that define or describe the historical data that your auto-adjusting budget is based on.
', ], ], 'IamActionDefinition' => [ 'base' => 'The Identity and Access Management (IAM) action definition details.
', 'refs' => [ 'Definition$IamActionDefinition' => 'The Identity and Access Management (IAM) action definition details.
', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'InstanceIds$member' => NULL, ], ], 'InstanceIds' => [ 'base' => NULL, 'refs' => [ 'SsmActionDefinition$InstanceIds' => 'The EC2 and RDS instance IDs.
', ], ], 'InternalErrorException' => [ 'base' => 'An error on the server occurred during the processing of your request. Try again later.
', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => 'The pagination token is invalid.
', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => 'An error on the client occurred. Typically, the cause is an invalid input value.
', 'refs' => [], ], 'MaxResults' => [ 'base' => 'An integer that represents how many entries a paginated response contains. The maximum is 100.
', 'refs' => [ 'DescribeBudgetActionHistoriesRequest$MaxResults' => NULL, 'DescribeBudgetActionsForAccountRequest$MaxResults' => NULL, 'DescribeBudgetActionsForBudgetRequest$MaxResults' => NULL, 'DescribeBudgetPerformanceHistoryRequest$MaxResults' => NULL, 'DescribeBudgetsRequest$MaxResults' => 'An optional integer that represents how many entries a paginated response contains. The maximum is 100.
', 'DescribeNotificationsForBudgetRequest$MaxResults' => 'An optional integer that represents how many entries a paginated response contains. The maximum is 100.
', 'DescribeSubscribersForNotificationRequest$MaxResults' => 'An optional integer that represents how many entries a paginated response contains. The maximum is 100.
', ], ], 'MaxResultsBudgetNotifications' => [ 'base' => NULL, 'refs' => [ 'DescribeBudgetNotificationsForAccountRequest$MaxResults' => 'An integer that shows how many budget name entries a paginated response contains.
', ], ], 'NotFoundException' => [ 'base' => 'We can’t locate the resource that you specified.
', 'refs' => [], ], 'Notification' => [ 'base' => 'A notification that\'s associated with a budget. A budget can have up to ten notifications.
Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:
A notificationType of ACTUAL
A thresholdType of PERCENTAGE
A comparisonOperator of GREATER_THAN
A notification threshold of 80
The notification that you want to create.
', 'CreateSubscriberRequest$Notification' => 'The notification that you want to create a subscriber for.
', 'DeleteNotificationRequest$Notification' => 'The notification that you want to delete.
', 'DeleteSubscriberRequest$Notification' => 'The notification whose subscriber you want to delete.
', 'DescribeSubscribersForNotificationRequest$Notification' => 'The notification whose subscribers you want to list.
', 'NotificationWithSubscribers$Notification' => 'The notification that\'s associated with a budget.
', 'Notifications$member' => NULL, 'UpdateNotificationRequest$OldNotification' => 'The previous notification that is associated with a budget.
', 'UpdateNotificationRequest$NewNotification' => 'The updated notification to be associated with a budget.
', 'UpdateSubscriberRequest$Notification' => 'The notification whose subscriber you want to update.
', ], ], 'NotificationState' => [ 'base' => NULL, 'refs' => [ 'Notification$NotificationState' => 'Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.
The threshold of a notification.
', 'refs' => [ 'ActionThreshold$ActionThresholdValue' => NULL, 'Notification$Threshold' => 'The threshold that\'s associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.
', ], ], 'NotificationType' => [ 'base' => 'The type of a notification. It must be ACTUAL or FORECASTED.
', 'refs' => [ 'Action$NotificationType' => NULL, 'CreateBudgetActionRequest$NotificationType' => NULL, 'Notification$NotificationType' => 'Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you\'re forecasted to spend (FORECASTED).
A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
', 'refs' => [ 'NotificationWithSubscribersList$member' => NULL, ], ], 'NotificationWithSubscribersList' => [ 'base' => 'A list of notifications, each with a list of subscribers.
', 'refs' => [ 'CreateBudgetRequest$NotificationsWithSubscribers' => 'A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, Amazon Web Services creates the notifications and subscribers for you.
A list of notifications.
', 'refs' => [ 'BudgetNotificationsForAccount$Notifications' => NULL, 'DescribeNotificationsForBudgetResponse$Notifications' => 'A list of notifications that are associated with a budget.
', ], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'CostTypes$IncludeTax' => 'Specifies whether a budget includes taxes.
The default value is true.
Specifies whether a budget includes subscriptions.
The default value is true.
Specifies whether a budget uses a blended rate.
The default value is false.
Specifies whether a budget includes refunds.
The default value is true.
Specifies whether a budget includes credits.
The default value is true.
Specifies whether a budget includes upfront RI costs.
The default value is true.
Specifies whether a budget includes recurring fees such as monthly RI fees.
The default value is true.
Specifies whether a budget includes non-RI subscription costs.
The default value is true.
Specifies whether a budget includes support subscription fees.
The default value is true.
Specifies whether a budget includes discounts.
The default value is true.
Specifies whether a budget uses the amortized rate.
The default value is false.
A string that represents a numeric value.
', 'refs' => [ 'Spend$Amount' => 'The cost or usage amount that\'s associated with a budget forecast, actual spend, or budget threshold.
', ], ], 'PlannedBudgetLimits' => [ 'base' => NULL, 'refs' => [ 'Budget$PlannedBudgetLimits' => 'A map containing multiple BudgetLimit, including current or future limits.
PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit.
For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.
For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the start of the quarter, UTC in epoch seconds.
If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.
If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.
After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.
DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets that are created with PlannedBudgetLimits. Budgets that are created without PlannedBudgetLimits only contain BudgetLimit. They don\'t contain PlannedBudgetLimits.
The Amazon Resource Name (ARN) of the policy to be attached.
', ], ], 'PolicyId' => [ 'base' => NULL, 'refs' => [ 'ScpActionDefinition$PolicyId' => 'The policy ID attached.
', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'SsmActionDefinition$Region' => 'The Region to run the SSM document.
', ], ], 'ResourceLockedException' => [ 'base' => 'The request was received and recognized by the server, but the server rejected that particular method for the requested resource.
', 'refs' => [], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'Roles$member' => NULL, ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'Action$ExecutionRoleArn' => 'The role passed for action execution and reversion. Roles and actions must be in the same account.
', 'CreateBudgetActionRequest$ExecutionRoleArn' => 'The role passed for action execution and reversion. Roles and actions must be in the same account.
', 'UpdateBudgetActionRequest$ExecutionRoleArn' => 'The role passed for action execution and reversion. Roles and actions must be in the same account.
', ], ], 'Roles' => [ 'base' => NULL, 'refs' => [ 'IamActionDefinition$Roles' => 'A list of roles to be attached. There must be at least one role.
', ], ], 'ScpActionDefinition' => [ 'base' => 'The service control policies (SCP) action definition details.
', 'refs' => [ 'Definition$ScpActionDefinition' => 'The service control policies (SCPs) action definition details.
', ], ], 'Spend' => [ 'base' => 'The amount of cost or usage that\'s measured for a budget.
For example, a Spend for 3 GB of S3 usage has the following parameters:
An Amount of 3
A unit of GB
The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.
BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can\'t use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.
The amount of cost or usage that you created the budget for.
', 'BudgetedAndActualAmounts$ActualAmount' => 'Your actual costs or usage for a budget period.
', 'CalculatedSpend$ActualSpend' => 'The amount of cost, usage, RI units, or Savings Plans units that you used.
', 'CalculatedSpend$ForecastedSpend' => 'The amount of cost, usage, RI units, or Savings Plans units that you\'re forecasted to use.
', 'PlannedBudgetLimits$value' => NULL, ], ], 'SsmActionDefinition' => [ 'base' => 'The Amazon Web Services Systems Manager (SSM) action definition details.
', 'refs' => [ 'Definition$SsmActionDefinition' => 'The Amazon Web Services Systems Manager (SSM) action definition details.
', ], ], 'Subscriber' => [ 'base' => 'The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
For example, an email subscriber has the following parameters:
A subscriptionType of EMAIL
An address of example@example.com
The subscriber that you want to associate with a budget notification.
', 'DeleteSubscriberRequest$Subscriber' => 'The subscriber that you want to delete.
', 'Subscribers$member' => NULL, 'UpdateSubscriberRequest$OldSubscriber' => 'The previous subscriber that is associated with a budget notification.
', 'UpdateSubscriberRequest$NewSubscriber' => 'The updated subscriber that is associated with a budget notification.
', ], ], 'SubscriberAddress' => [ 'base' => 'A string that contains an email address or SNS topic for the subscriber\'s address.
', 'refs' => [ 'Subscriber$Address' => 'The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.
When you create a subscriber, the value of Address can\'t contain line breaks.
A list of subscribers.
', 'refs' => [ 'Action$Subscribers' => NULL, 'CreateBudgetActionRequest$Subscribers' => NULL, 'CreateNotificationRequest$Subscribers' => 'A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.
', 'DescribeSubscribersForNotificationResponse$Subscribers' => 'A list of subscribers that are associated with a notification.
', 'NotificationWithSubscribers$Subscribers' => 'A list of subscribers who are subscribed to this notification.
', 'UpdateBudgetActionRequest$Subscribers' => NULL, ], ], 'SubscriptionType' => [ 'base' => 'The subscription type of the subscriber. It can be SMS or EMAIL.
', 'refs' => [ 'Subscriber$SubscriptionType' => 'The type of notification that Amazon Web Services sends to a subscriber.
', ], ], 'TargetId' => [ 'base' => NULL, 'refs' => [ 'TargetIds$member' => NULL, ], ], 'TargetIds' => [ 'base' => NULL, 'refs' => [ 'ScpActionDefinition$TargetIds' => 'A list of target IDs.
', ], ], 'ThresholdType' => [ 'base' => 'The type of threshold for a notification.
', 'refs' => [ 'ActionThreshold$ActionThresholdType' => NULL, 'Notification$ThresholdType' => 'The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
', 'refs' => [], ], 'TimePeriod' => [ 'base' => 'The period of time that\'s covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
', 'refs' => [ 'Budget$TimePeriod' => 'The period of time that\'s covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.
If you create your budget and don\'t specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn\'t set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. If you didn\'t specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.
You can change either date with the UpdateBudget operation.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
', 'BudgetedAndActualAmounts$TimePeriod' => 'The time period that\'s covered by this budget comparison.
', 'DescribeBudgetActionHistoriesRequest$TimePeriod' => NULL, 'DescribeBudgetPerformanceHistoryRequest$TimePeriod' => 'Retrieves how often the budget went into an ALARM state for the specified time period.
The time unit of the budget, such as MONTHLY or QUARTERLY.
', 'refs' => [ 'Budget$TimeUnit' => 'The length of time until a budget resets the actual and forecasted spend.
', 'BudgetPerformanceHistory$TimeUnit' => NULL, ], ], 'UnitValue' => [ 'base' => 'A string that represents the spend unit of a budget. It can\'t be null or empty.
', 'refs' => [ 'Spend$Unit' => 'The unit of measurement that\'s used for the budget forecast, actual spend, or budget threshold, such as USD or GBP.
', ], ], 'UpdateBudgetActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBudgetActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBudgetRequest' => [ 'base' => 'Request of UpdateBudget
', 'refs' => [], ], 'UpdateBudgetResponse' => [ 'base' => 'Response of UpdateBudget
', 'refs' => [], ], 'UpdateNotificationRequest' => [ 'base' => 'Request of UpdateNotification
', 'refs' => [], ], 'UpdateNotificationResponse' => [ 'base' => 'Response of UpdateNotification
', 'refs' => [], ], 'UpdateSubscriberRequest' => [ 'base' => 'Request of UpdateSubscriber
', 'refs' => [], ], 'UpdateSubscriberResponse' => [ 'base' => 'Response of UpdateSubscriber
', 'refs' => [], ], 'User' => [ 'base' => NULL, 'refs' => [ 'Users$member' => NULL, ], ], 'Users' => [ 'base' => NULL, 'refs' => [ 'IamActionDefinition$Users' => 'A list of users to be attached. There must be at least one user.
', ], ], 'errorMessage' => [ 'base' => 'The error message the exception carries.
', 'refs' => [ 'AccessDeniedException$Message' => NULL, 'CreationLimitExceededException$Message' => NULL, 'DuplicateRecordException$Message' => NULL, 'ExpiredNextTokenException$Message' => NULL, 'InternalErrorException$Message' => NULL, 'InvalidNextTokenException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'NotFoundException$Message' => NULL, 'ResourceLockedException$Message' => NULL, 'ThrottlingException$Message' => NULL, ], ], ],]; diff --git a/src/data/budgets/2016-10-20/endpoint-rule-set-1.json b/src/data/budgets/2016-10-20/endpoint-rule-set-1.json index 9d1e4af5d4..c7e70d266c 100644 --- a/src/data/budgets/2016-10-20/endpoint-rule-set-1.json +++ b/src/data/budgets/2016-10-20/endpoint-rule-set-1.json @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,94 +45,175 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ { - "fn": "parseURL", + "fn": "aws.partition", "argv": [ { - "ref": "Endpoint" + "ref": "Region" } ], - "assign": "url" + "assign": "PartitionResult" } ], "type": "tree", "rules": [ { "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, - true + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": "https://budgets.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "stringEquals", + "argv": [ { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ { - "ref": "UseDualStack" + "ref": "PartitionResult" }, - true + "name" ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + }, + "aws-cn" + ] }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ + false + ] + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + false + ] + } + ], + "endpoint": { + "url": "https://budgets.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "cn-northwest-1" + } ] }, - "aws" - ] - } - ], - "type": "tree", - "rules": [ + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -195,16 +275,8 @@ { "conditions": [], "endpoint": { - "url": "https://budgets-fips.{Region}.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, + "url": "https://budgets-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" @@ -255,16 +327,8 @@ { "conditions": [], "endpoint": { - "url": "https://budgets-fips.{Region}.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, + "url": "https://budgets-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" @@ -315,16 +379,8 @@ { "conditions": [], "endpoint": { - "url": "https://budgets.{Region}.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, + "url": "https://budgets.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" @@ -341,514 +397,8 @@ { "conditions": [], "endpoint": { - "url": "https://budgets.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets.{Region}.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://budgets.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-global" - ] - } - ], - "endpoint": { - "url": "https://budgets.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-cn-global" - ] - } - ], - "endpoint": { - "url": "https://budgets.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://budgets.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, + "url": "https://budgets.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" @@ -856,6 +406,11 @@ ] } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } \ No newline at end of file diff --git a/src/data/budgets/2016-10-20/endpoint-rule-set-1.json.php b/src/data/budgets/2016-10-20/endpoint-rule-set-1.json.php index c3c0158719..786a99374d 100644 --- a/src/data/budgets/2016-10-20/endpoint-rule-set-1.json.php +++ b/src/data/budgets/2016-10-20/endpoint-rule-set-1.json.php @@ -1,3 +1,3 @@ '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], [ 'fn' => 'parseURL', 'argv' => [ [ 'ref' => 'Endpoint', ], ], 'assign' => 'url', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [ [ 'fn' => 'stringEquals', 'argv' => [ [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'name', ], ], 'aws', ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets-fips.{Region}.api.aws', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'us-east-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets-fips.{Region}.amazonaws.com', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'us-east-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets.{Region}.api.aws', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'us-east-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets.amazonaws.com', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'us-east-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [ [ 'fn' => 'stringEquals', 'argv' => [ [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'name', ], ], 'aws-cn', ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets-fips.{Region}.api.amazonwebservices.com.cn', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'cn-northwest-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets-fips.{Region}.amazonaws.com.cn', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'cn-northwest-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets.{Region}.api.amazonwebservices.com.cn', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'cn-northwest-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets.amazonaws.com.cn', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'cn-northwest-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'stringEquals', 'argv' => [ [ 'ref' => 'Region', ], 'aws-global', ], ], ], 'endpoint' => [ 'url' => 'https://budgets.amazonaws.com', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'us-east-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], [ 'conditions' => [ [ 'fn' => 'stringEquals', 'argv' => [ [ 'ref' => 'Region', ], 'aws-cn-global', ], ], ], 'endpoint' => [ 'url' => 'https://budgets.amazonaws.com.cn', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'cn-northwest-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], ],]; +return [ 'version' => '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'stringEquals', 'argv' => [ [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'name', ], ], 'aws', ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], false, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], false, ], ], ], 'endpoint' => [ 'url' => 'https://budgets.amazonaws.com', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'us-east-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], [ 'conditions' => [ [ 'fn' => 'stringEquals', 'argv' => [ [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'name', ], ], 'aws-cn', ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], false, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], false, ], ], ], 'endpoint' => [ 'url' => 'https://budgets.amazonaws.com.cn', 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'cn-northwest-1', ], ], ], 'headers' => [], ], 'type' => 'endpoint', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://budgets.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ],]; diff --git a/src/data/budgets/2016-10-20/endpoint-tests-1.json b/src/data/budgets/2016-10-20/endpoint-tests-1.json index 8d97bc368e..073c32f8f1 100644 --- a/src/data/budgets/2016-10-20/endpoint-tests-1.json +++ b/src/data/budgets/2016-10-20/endpoint-tests-1.json @@ -1,5 +1,88 @@ { "testCases": [ + { + "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://budgets.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://budgets.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", "expect": { @@ -18,12 +101,51 @@ }, "params": { "Region": "aws-cn-global", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -31,21 +153,169 @@ { "name": "sigv4", "signingName": "budgets", - "signingRegion": "us-east-1" + "signingRegion": "cn-northwest-1" } ] }, - "url": "https://budgets.amazonaws.com" + "url": "https://budgets.amazonaws.com.cn" } }, "params": { - "Region": "aws-global", - "UseDualStack": false, - "UseFIPS": false + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -53,8 +323,21 @@ }, "params": { "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -65,8 +348,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -77,10 +360,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/src/data/budgets/2016-10-20/endpoint-tests-1.json.php b/src/data/budgets/2016-10-20/endpoint-tests-1.json.php index bcac251327..2dca807756 100644 --- a/src/data/budgets/2016-10-20/endpoint-tests-1.json.php +++ b/src/data/budgets/2016-10-20/endpoint-tests-1.json.php @@ -1,3 +1,3 @@ [ [ 'documentation' => 'For region aws-cn-global with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'cn-northwest-1', ], ], ], 'url' => 'https://budgets.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'aws-cn-global', 'UseDualStack' => false, 'UseFIPS' => false, ], ], [ 'documentation' => 'For region aws-global with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'us-east-1', ], ], ], 'url' => 'https://budgets.amazonaws.com', ], ], 'params' => [ 'Region' => 'aws-global', 'UseDualStack' => false, 'UseFIPS' => false, ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => false, 'UseFIPS' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips enabled and dualstack disabled', 'expect' => [ 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => false, 'UseFIPS' => true, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack enabled', 'expect' => [ 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => true, 'UseFIPS' => false, 'Endpoint' => 'https://example.com', ], ], ], 'version' => '1.0',]; +return [ 'testCases' => [ [ 'documentation' => 'For region aws-global with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'us-east-1', ], ], ], 'url' => 'https://budgets.amazonaws.com', ], ], 'params' => [ 'Region' => 'aws-global', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets-fips.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets-fips.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'us-east-1', ], ], ], 'url' => 'https://budgets.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region aws-cn-global with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'cn-northwest-1', ], ], ], 'url' => 'https://budgets.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'aws-cn-global', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets-fips.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets-fips.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'properties' => [ 'authSchemes' => [ [ 'name' => 'sigv4', 'signingName' => 'budgets', 'signingRegion' => 'cn-northwest-1', ], ], ], 'url' => 'https://budgets.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets-fips.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets-fips.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets-fips.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets-fips.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://budgets.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For custom endpoint with region set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with region not set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips enabled and dualstack disabled', 'expect' => [ 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack enabled', 'expect' => [ 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'Missing region', 'expect' => [ 'error' => 'Invalid Configuration: Missing Region', ], ], ], 'version' => '1.0',]; diff --git a/src/data/cognito-idp/2016-04-18/api-2.json b/src/data/cognito-idp/2016-04-18/api-2.json index 6e739fb661..1b519d9f27 100644 --- a/src/data/cognito-idp/2016-04-18/api-2.json +++ b/src/data/cognito-idp/2016-04-18/api-2.json @@ -1137,6 +1137,22 @@ {"shape":"InternalErrorException"} ] }, + "GetLogDeliveryConfiguration":{ + "name":"GetLogDeliveryConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLogDeliveryConfigurationRequest"}, + "output":{"shape":"GetLogDeliveryConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "GetSigningCertificate":{ "name":"GetSigningCertificate", "http":{ @@ -1521,6 +1537,22 @@ {"shape":"ForbiddenException"} ] }, + "SetLogDeliveryConfiguration":{ + "name":"SetLogDeliveryConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetLogDeliveryConfigurationRequest"}, + "output":{"shape":"SetLogDeliveryConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "SetRiskConfiguration":{ "name":"SetRiskConfiguration", "http":{ @@ -1935,7 +1967,11 @@ } }, "shapes":{ - "AWSAccountIdType":{"type":"string"}, + "AWSAccountIdType":{ + "type":"string", + "max":12, + "pattern":"[0-9]+" + }, "AccessTokenValidityType":{ "type":"integer", "max":86400, @@ -2663,7 +2699,11 @@ "max":200 }, "BooleanType":{"type":"boolean"}, - "CSSType":{"type":"string"}, + "CSSType":{ + "type":"string", + "max":131072, + "min":0 + }, "CSSVersionType":{"type":"string"}, "CallbackURLsListType":{ "type":"list", @@ -2719,8 +2759,7 @@ "ChallengeResponsesType":{ "type":"map", "key":{"shape":"StringType"}, - "value":{"shape":"StringType"}, - "sensitive":true + "value":{"shape":"StringType"} }, "ChangePasswordRequest":{ "type":"structure", @@ -2774,6 +2813,12 @@ "pattern":"[\\w+]+", "sensitive":true }, + "CloudWatchLogsConfigurationType":{ + "type":"structure", + "members":{ + "LogGroupArn":{"shape":"ArnType"} + } + }, "CodeDeliveryDetailsListType":{ "type":"list", "member":{"shape":"CodeDeliveryDetailsType"} @@ -3584,6 +3629,10 @@ "CompromisedCredentialsDetected":{"shape":"WrappedBooleanType"} } }, + "EventSourceName":{ + "type":"string", + "enum":["userNotification"] + }, "EventType":{ "type":"string", "enum":[ @@ -3727,6 +3776,19 @@ "IdentityProvider":{"shape":"IdentityProviderType"} } }, + "GetLogDeliveryConfigurationRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{"shape":"UserPoolIdType"} + } + }, + "GetLogDeliveryConfigurationResponse":{ + "type":"structure", + "members":{ + "LogDeliveryConfiguration":{"shape":"LogDeliveryConfigurationType"} + } + }, "GetSigningCertificateRequest":{ "type":"structure", "required":["UserPoolId"], @@ -3906,7 +3968,11 @@ "max":50, "min":0 }, - "ImageFileType":{"type":"blob"}, + "ImageFileType":{ + "type":"blob", + "max":131072, + "min":0 + }, "ImageUrlType":{"type":"string"}, "InitiateAuthRequest":{ "type":"structure", @@ -4203,6 +4269,39 @@ "PaginationToken":{"shape":"SearchPaginationTokenType"} } }, + "LogConfigurationListType":{ + "type":"list", + "member":{"shape":"LogConfigurationType"}, + "max":1, + "min":0 + }, + "LogConfigurationType":{ + "type":"structure", + "required":[ + "LogLevel", + "EventSource" + ], + "members":{ + "LogLevel":{"shape":"LogLevel"}, + "EventSource":{"shape":"EventSourceName"}, + "CloudWatchLogsConfiguration":{"shape":"CloudWatchLogsConfigurationType"} + } + }, + "LogDeliveryConfigurationType":{ + "type":"structure", + "required":[ + "UserPoolId", + "LogConfigurations" + ], + "members":{ + "UserPoolId":{"shape":"UserPoolIdType"}, + "LogConfigurations":{"shape":"LogConfigurationListType"} + } + }, + "LogLevel":{ + "type":"string", + "enum":["ERROR"] + }, "LogoutURLsListType":{ "type":"list", "member":{"shape":"RedirectUrlType"}, @@ -4708,8 +4807,24 @@ "SessionType":{ "type":"string", "max":2048, - "min":20, - "sensitive":true + "min":20 + }, + "SetLogDeliveryConfigurationRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "LogConfigurations" + ], + "members":{ + "UserPoolId":{"shape":"UserPoolIdType"}, + "LogConfigurations":{"shape":"LogConfigurationListType"} + } + }, + "SetLogDeliveryConfigurationResponse":{ + "type":"structure", + "members":{ + "LogDeliveryConfiguration":{"shape":"LogDeliveryConfigurationType"} + } }, "SetRiskConfigurationRequest":{ "type":"structure", @@ -4863,8 +4978,7 @@ "type":"string", "max":6, "min":6, - "pattern":"[0-9]+", - "sensitive":true + "pattern":"[0-9]+" }, "SoftwareTokenMfaConfigType":{ "type":"structure", @@ -4927,7 +5041,11 @@ "MaxLength":{"shape":"StringType"} } }, - "StringType":{"type":"string"}, + "StringType":{ + "type":"string", + "max":131072, + "min":0 + }, "SupportedIdentityProvidersListType":{ "type":"list", "member":{"shape":"ProviderNameType"} @@ -5285,8 +5403,7 @@ "members":{ "IpAddress":{"shape":"StringType"}, "EncodedData":{"shape":"StringType"} - }, - "sensitive":true + } }, "UserFilterType":{ "type":"string", diff --git a/src/data/cognito-idp/2016-04-18/api-2.json.php b/src/data/cognito-idp/2016-04-18/api-2.json.php index 5ccbd2e749..dbf867bb46 100644 --- a/src/data/cognito-idp/2016-04-18/api-2.json.php +++ b/src/data/cognito-idp/2016-04-18/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2016-04-18', 'endpointPrefix' => 'cognito-idp', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon Cognito Identity Provider', 'serviceId' => 'Cognito Identity Provider', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSCognitoIdentityProviderService', 'uid' => 'cognito-idp-2016-04-18', ], 'operations' => [ 'AddCustomAttributes' => [ 'name' => 'AddCustomAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddCustomAttributesRequest', ], 'output' => [ 'shape' => 'AddCustomAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserImportInProgressException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminAddUserToGroup' => [ 'name' => 'AdminAddUserToGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminAddUserToGroupRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminConfirmSignUp' => [ 'name' => 'AdminConfirmSignUp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminConfirmSignUpRequest', ], 'output' => [ 'shape' => 'AdminConfirmSignUpResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyFailedAttemptsException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminCreateUser' => [ 'name' => 'AdminCreateUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminCreateUserRequest', ], 'output' => [ 'shape' => 'AdminCreateUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UsernameExistsException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UnsupportedUserStateException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminDeleteUser' => [ 'name' => 'AdminDeleteUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminDeleteUserRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminDeleteUserAttributes' => [ 'name' => 'AdminDeleteUserAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminDeleteUserAttributesRequest', ], 'output' => [ 'shape' => 'AdminDeleteUserAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminDisableProviderForUser' => [ 'name' => 'AdminDisableProviderForUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminDisableProviderForUserRequest', ], 'output' => [ 'shape' => 'AdminDisableProviderForUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminDisableUser' => [ 'name' => 'AdminDisableUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminDisableUserRequest', ], 'output' => [ 'shape' => 'AdminDisableUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminEnableUser' => [ 'name' => 'AdminEnableUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminEnableUserRequest', ], 'output' => [ 'shape' => 'AdminEnableUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminForgetDevice' => [ 'name' => 'AdminForgetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminForgetDeviceRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminGetDevice' => [ 'name' => 'AdminGetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminGetDeviceRequest', ], 'output' => [ 'shape' => 'AdminGetDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'NotAuthorizedException', ], ], ], 'AdminGetUser' => [ 'name' => 'AdminGetUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminGetUserRequest', ], 'output' => [ 'shape' => 'AdminGetUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminInitiateAuth' => [ 'name' => 'AdminInitiateAuth', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminInitiateAuthRequest', ], 'output' => [ 'shape' => 'AdminInitiateAuthResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'MFAMethodNotFoundException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], ], ], 'AdminLinkProviderForUser' => [ 'name' => 'AdminLinkProviderForUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminLinkProviderForUserRequest', ], 'output' => [ 'shape' => 'AdminLinkProviderForUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminListDevices' => [ 'name' => 'AdminListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminListDevicesRequest', ], 'output' => [ 'shape' => 'AdminListDevicesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'NotAuthorizedException', ], ], ], 'AdminListGroupsForUser' => [ 'name' => 'AdminListGroupsForUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminListGroupsForUserRequest', ], 'output' => [ 'shape' => 'AdminListGroupsForUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminListUserAuthEvents' => [ 'name' => 'AdminListUserAuthEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminListUserAuthEventsRequest', ], 'output' => [ 'shape' => 'AdminListUserAuthEventsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminRemoveUserFromGroup' => [ 'name' => 'AdminRemoveUserFromGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminRemoveUserFromGroupRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminResetUserPassword' => [ 'name' => 'AdminResetUserPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminResetUserPasswordRequest', ], 'output' => [ 'shape' => 'AdminResetUserPasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminRespondToAuthChallenge' => [ 'name' => 'AdminRespondToAuthChallenge', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminRespondToAuthChallengeRequest', ], 'output' => [ 'shape' => 'AdminRespondToAuthChallengeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'MFAMethodNotFoundException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'SoftwareTokenMFANotFoundException', ], ], ], 'AdminSetUserMFAPreference' => [ 'name' => 'AdminSetUserMFAPreference', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminSetUserMFAPreferenceRequest', ], 'output' => [ 'shape' => 'AdminSetUserMFAPreferenceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminSetUserPassword' => [ 'name' => 'AdminSetUserPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminSetUserPasswordRequest', ], 'output' => [ 'shape' => 'AdminSetUserPasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], ], ], 'AdminSetUserSettings' => [ 'name' => 'AdminSetUserSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminSetUserSettingsRequest', ], 'output' => [ 'shape' => 'AdminSetUserSettingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminUpdateAuthEventFeedback' => [ 'name' => 'AdminUpdateAuthEventFeedback', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminUpdateAuthEventFeedbackRequest', ], 'output' => [ 'shape' => 'AdminUpdateAuthEventFeedbackResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminUpdateDeviceStatus' => [ 'name' => 'AdminUpdateDeviceStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminUpdateDeviceStatusRequest', ], 'output' => [ 'shape' => 'AdminUpdateDeviceStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminUpdateUserAttributes' => [ 'name' => 'AdminUpdateUserAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminUpdateUserAttributesRequest', ], 'output' => [ 'shape' => 'AdminUpdateUserAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], ], ], 'AdminUserGlobalSignOut' => [ 'name' => 'AdminUserGlobalSignOut', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminUserGlobalSignOutRequest', ], 'output' => [ 'shape' => 'AdminUserGlobalSignOutResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AssociateSoftwareToken' => [ 'name' => 'AssociateSoftwareToken', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateSoftwareTokenRequest', ], 'output' => [ 'shape' => 'AssociateSoftwareTokenResponse', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'SoftwareTokenMFANotFoundException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'ChangePassword' => [ 'name' => 'ChangePassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ChangePasswordRequest', ], 'output' => [ 'shape' => 'ChangePasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'ConfirmDevice' => [ 'name' => 'ConfirmDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmDeviceRequest', ], 'output' => [ 'shape' => 'ConfirmDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'UsernameExistsException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'ConfirmForgotPassword' => [ 'name' => 'ConfirmForgotPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmForgotPasswordRequest', ], 'output' => [ 'shape' => 'ConfirmForgotPasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'TooManyFailedAttemptsException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'ConfirmSignUp' => [ 'name' => 'ConfirmSignUp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmSignUpRequest', ], 'output' => [ 'shape' => 'ConfirmSignUpResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyFailedAttemptsException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'CreateGroup' => [ 'name' => 'CreateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGroupRequest', ], 'output' => [ 'shape' => 'CreateGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'GroupExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateIdentityProvider' => [ 'name' => 'CreateIdentityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateIdentityProviderRequest', ], 'output' => [ 'shape' => 'CreateIdentityProviderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateProviderException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateResourceServer' => [ 'name' => 'CreateResourceServer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResourceServerRequest', ], 'output' => [ 'shape' => 'CreateResourceServerResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateUserImportJob' => [ 'name' => 'CreateUserImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserImportJobRequest', ], 'output' => [ 'shape' => 'CreateUserImportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateUserPool' => [ 'name' => 'CreateUserPool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserPoolRequest', ], 'output' => [ 'shape' => 'CreateUserPoolResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserPoolTaggingException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateUserPoolClient' => [ 'name' => 'CreateUserPoolClient', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserPoolClientRequest', ], 'output' => [ 'shape' => 'CreateUserPoolClientResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ScopeDoesNotExistException', ], [ 'shape' => 'InvalidOAuthFlowException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateUserPoolDomain' => [ 'name' => 'CreateUserPoolDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserPoolDomainRequest', ], 'output' => [ 'shape' => 'CreateUserPoolDomainResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteIdentityProvider' => [ 'name' => 'DeleteIdentityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteIdentityProviderRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnsupportedIdentityProviderException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteResourceServer' => [ 'name' => 'DeleteResourceServer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResourceServerRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'DeleteUserAttributes' => [ 'name' => 'DeleteUserAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserAttributesRequest', ], 'output' => [ 'shape' => 'DeleteUserAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'DeleteUserPool' => [ 'name' => 'DeleteUserPool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserPoolRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserImportInProgressException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteUserPoolClient' => [ 'name' => 'DeleteUserPoolClient', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserPoolClientRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteUserPoolDomain' => [ 'name' => 'DeleteUserPoolDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserPoolDomainRequest', ], 'output' => [ 'shape' => 'DeleteUserPoolDomainResponse', ], 'errors' => [ [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeIdentityProvider' => [ 'name' => 'DescribeIdentityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeIdentityProviderRequest', ], 'output' => [ 'shape' => 'DescribeIdentityProviderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeResourceServer' => [ 'name' => 'DescribeResourceServer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeResourceServerRequest', ], 'output' => [ 'shape' => 'DescribeResourceServerResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeRiskConfiguration' => [ 'name' => 'DescribeRiskConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRiskConfigurationRequest', ], 'output' => [ 'shape' => 'DescribeRiskConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeUserImportJob' => [ 'name' => 'DescribeUserImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserImportJobRequest', ], 'output' => [ 'shape' => 'DescribeUserImportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeUserPool' => [ 'name' => 'DescribeUserPool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserPoolRequest', ], 'output' => [ 'shape' => 'DescribeUserPoolResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserPoolTaggingException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeUserPoolClient' => [ 'name' => 'DescribeUserPoolClient', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserPoolClientRequest', ], 'output' => [ 'shape' => 'DescribeUserPoolClientResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeUserPoolDomain' => [ 'name' => 'DescribeUserPoolDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserPoolDomainRequest', ], 'output' => [ 'shape' => 'DescribeUserPoolDomainResponse', ], 'errors' => [ [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ForgetDevice' => [ 'name' => 'ForgetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ForgetDeviceRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'ForgotPassword' => [ 'name' => 'ForgotPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ForgotPasswordRequest', ], 'output' => [ 'shape' => 'ForgotPasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'GetCSVHeader' => [ 'name' => 'GetCSVHeader', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCSVHeaderRequest', ], 'output' => [ 'shape' => 'GetCSVHeaderResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetDevice' => [ 'name' => 'GetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceRequest', ], 'output' => [ 'shape' => 'GetDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'GetGroup' => [ 'name' => 'GetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetGroupRequest', ], 'output' => [ 'shape' => 'GetGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetIdentityProviderByIdentifier' => [ 'name' => 'GetIdentityProviderByIdentifier', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetIdentityProviderByIdentifierRequest', ], 'output' => [ 'shape' => 'GetIdentityProviderByIdentifierResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetSigningCertificate' => [ 'name' => 'GetSigningCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSigningCertificateRequest', ], 'output' => [ 'shape' => 'GetSigningCertificateResponse', ], 'errors' => [ [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetUICustomization' => [ 'name' => 'GetUICustomization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUICustomizationRequest', ], 'output' => [ 'shape' => 'GetUICustomizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetUser' => [ 'name' => 'GetUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUserRequest', ], 'output' => [ 'shape' => 'GetUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'GetUserAttributeVerificationCode' => [ 'name' => 'GetUserAttributeVerificationCode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUserAttributeVerificationCodeRequest', ], 'output' => [ 'shape' => 'GetUserAttributeVerificationCodeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'GetUserPoolMfaConfig' => [ 'name' => 'GetUserPoolMfaConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUserPoolMfaConfigRequest', ], 'output' => [ 'shape' => 'GetUserPoolMfaConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GlobalSignOut' => [ 'name' => 'GlobalSignOut', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GlobalSignOutRequest', ], 'output' => [ 'shape' => 'GlobalSignOutResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'InitiateAuth' => [ 'name' => 'InitiateAuth', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'InitiateAuthRequest', ], 'output' => [ 'shape' => 'InitiateAuthResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListIdentityProviders' => [ 'name' => 'ListIdentityProviders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListIdentityProvidersRequest', ], 'output' => [ 'shape' => 'ListIdentityProvidersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListResourceServers' => [ 'name' => 'ListResourceServers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceServersRequest', ], 'output' => [ 'shape' => 'ListResourceServersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUserImportJobs' => [ 'name' => 'ListUserImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserImportJobsRequest', ], 'output' => [ 'shape' => 'ListUserImportJobsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUserPoolClients' => [ 'name' => 'ListUserPoolClients', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserPoolClientsRequest', ], 'output' => [ 'shape' => 'ListUserPoolClientsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUserPools' => [ 'name' => 'ListUserPools', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserPoolsRequest', ], 'output' => [ 'shape' => 'ListUserPoolsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUsers' => [ 'name' => 'ListUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUsersRequest', ], 'output' => [ 'shape' => 'ListUsersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUsersInGroup' => [ 'name' => 'ListUsersInGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUsersInGroupRequest', ], 'output' => [ 'shape' => 'ListUsersInGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ResendConfirmationCode' => [ 'name' => 'ResendConfirmationCode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResendConfirmationCodeRequest', ], 'output' => [ 'shape' => 'ResendConfirmationCodeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'RespondToAuthChallenge' => [ 'name' => 'RespondToAuthChallenge', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RespondToAuthChallengeRequest', ], 'output' => [ 'shape' => 'RespondToAuthChallengeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'MFAMethodNotFoundException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'SoftwareTokenMFANotFoundException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'RevokeToken' => [ 'name' => 'RevokeToken', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeTokenRequest', ], 'output' => [ 'shape' => 'RevokeTokenResponse', ], 'errors' => [ [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnsupportedOperationException', ], [ 'shape' => 'UnsupportedTokenTypeException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'SetRiskConfiguration' => [ 'name' => 'SetRiskConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetRiskConfigurationRequest', ], 'output' => [ 'shape' => 'SetRiskConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'SetUICustomization' => [ 'name' => 'SetUICustomization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUICustomizationRequest', ], 'output' => [ 'shape' => 'SetUICustomizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'SetUserMFAPreference' => [ 'name' => 'SetUserMFAPreference', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUserMFAPreferenceRequest', ], 'output' => [ 'shape' => 'SetUserMFAPreferenceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'SetUserPoolMfaConfig' => [ 'name' => 'SetUserPoolMfaConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUserPoolMfaConfigRequest', ], 'output' => [ 'shape' => 'SetUserPoolMfaConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'SetUserSettings' => [ 'name' => 'SetUserSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUserSettingsRequest', ], 'output' => [ 'shape' => 'SetUserSettingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'SignUp' => [ 'name' => 'SignUp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SignUpRequest', ], 'output' => [ 'shape' => 'SignUpResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'UsernameExistsException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'StartUserImportJob' => [ 'name' => 'StartUserImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartUserImportJobRequest', ], 'output' => [ 'shape' => 'StartUserImportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'NotAuthorizedException', ], ], ], 'StopUserImportJob' => [ 'name' => 'StopUserImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopUserImportJobRequest', ], 'output' => [ 'shape' => 'StopUserImportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'NotAuthorizedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateAuthEventFeedback' => [ 'name' => 'UpdateAuthEventFeedback', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAuthEventFeedbackRequest', ], 'output' => [ 'shape' => 'UpdateAuthEventFeedbackResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateDeviceStatus' => [ 'name' => 'UpdateDeviceStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceStatusRequest', ], 'output' => [ 'shape' => 'UpdateDeviceStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'UpdateGroup' => [ 'name' => 'UpdateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateGroupRequest', ], 'output' => [ 'shape' => 'UpdateGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateIdentityProvider' => [ 'name' => 'UpdateIdentityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateIdentityProviderRequest', ], 'output' => [ 'shape' => 'UpdateIdentityProviderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnsupportedIdentityProviderException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateResourceServer' => [ 'name' => 'UpdateResourceServer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResourceServerRequest', ], 'output' => [ 'shape' => 'UpdateResourceServerResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateUserAttributes' => [ 'name' => 'UpdateUserAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserAttributesRequest', ], 'output' => [ 'shape' => 'UpdateUserAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'UpdateUserPool' => [ 'name' => 'UpdateUserPool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserPoolRequest', ], 'output' => [ 'shape' => 'UpdateUserPoolResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserImportInProgressException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'UserPoolTaggingException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], ], ], 'UpdateUserPoolClient' => [ 'name' => 'UpdateUserPoolClient', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserPoolClientRequest', ], 'output' => [ 'shape' => 'UpdateUserPoolClientResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ScopeDoesNotExistException', ], [ 'shape' => 'InvalidOAuthFlowException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateUserPoolDomain' => [ 'name' => 'UpdateUserPoolDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserPoolDomainRequest', ], 'output' => [ 'shape' => 'UpdateUserPoolDomainResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'VerifySoftwareToken' => [ 'name' => 'VerifySoftwareToken', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'VerifySoftwareTokenRequest', ], 'output' => [ 'shape' => 'VerifySoftwareTokenResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'EnableSoftwareTokenMFAException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'SoftwareTokenMFANotFoundException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'VerifyUserAttribute' => [ 'name' => 'VerifyUserAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'VerifyUserAttributeRequest', ], 'output' => [ 'shape' => 'VerifyUserAttributeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], ], 'shapes' => [ 'AWSAccountIdType' => [ 'type' => 'string', ], 'AccessTokenValidityType' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'AccountRecoverySettingType' => [ 'type' => 'structure', 'members' => [ 'RecoveryMechanisms' => [ 'shape' => 'RecoveryMechanismsType', ], ], ], 'AccountTakeoverActionNotifyType' => [ 'type' => 'boolean', ], 'AccountTakeoverActionType' => [ 'type' => 'structure', 'required' => [ 'Notify', 'EventAction', ], 'members' => [ 'Notify' => [ 'shape' => 'AccountTakeoverActionNotifyType', ], 'EventAction' => [ 'shape' => 'AccountTakeoverEventActionType', ], ], ], 'AccountTakeoverActionsType' => [ 'type' => 'structure', 'members' => [ 'LowAction' => [ 'shape' => 'AccountTakeoverActionType', ], 'MediumAction' => [ 'shape' => 'AccountTakeoverActionType', ], 'HighAction' => [ 'shape' => 'AccountTakeoverActionType', ], ], ], 'AccountTakeoverEventActionType' => [ 'type' => 'string', 'enum' => [ 'BLOCK', 'MFA_IF_CONFIGURED', 'MFA_REQUIRED', 'NO_ACTION', ], ], 'AccountTakeoverRiskConfigurationType' => [ 'type' => 'structure', 'required' => [ 'Actions', ], 'members' => [ 'NotifyConfiguration' => [ 'shape' => 'NotifyConfigurationType', ], 'Actions' => [ 'shape' => 'AccountTakeoverActionsType', ], ], ], 'AddCustomAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'CustomAttributes', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CustomAttributes' => [ 'shape' => 'CustomAttributesListType', ], ], ], 'AddCustomAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminAddUserToGroupRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'GroupName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'GroupName' => [ 'shape' => 'GroupNameType', ], ], ], 'AdminConfirmSignUpRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminConfirmSignUpResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminCreateUserConfigType' => [ 'type' => 'structure', 'members' => [ 'AllowAdminCreateUserOnly' => [ 'shape' => 'BooleanType', ], 'UnusedAccountValidityDays' => [ 'shape' => 'AdminCreateUserUnusedAccountValidityDaysType', ], 'InviteMessageTemplate' => [ 'shape' => 'MessageTemplateType', ], ], ], 'AdminCreateUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'ValidationData' => [ 'shape' => 'AttributeListType', ], 'TemporaryPassword' => [ 'shape' => 'PasswordType', ], 'ForceAliasCreation' => [ 'shape' => 'ForceAliasCreation', ], 'MessageAction' => [ 'shape' => 'MessageActionType', ], 'DesiredDeliveryMediums' => [ 'shape' => 'DeliveryMediumListType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminCreateUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'UserType', ], ], ], 'AdminCreateUserUnusedAccountValidityDaysType' => [ 'type' => 'integer', 'max' => 365, 'min' => 0, ], 'AdminDeleteUserAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'UserAttributeNames', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributeNames' => [ 'shape' => 'AttributeNameListType', ], ], ], 'AdminDeleteUserAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminDeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminDisableProviderForUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'User', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'StringType', ], 'User' => [ 'shape' => 'ProviderUserIdentifierType', ], ], ], 'AdminDisableProviderForUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminDisableUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminDisableUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminEnableUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminEnableUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminForgetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'DeviceKey', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], ], ], 'AdminGetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceKey', 'UserPoolId', 'Username', ], 'members' => [ 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminGetDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'Device', ], 'members' => [ 'Device' => [ 'shape' => 'DeviceType', ], ], ], 'AdminGetUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminGetUserResponse' => [ 'type' => 'structure', 'required' => [ 'Username', ], 'members' => [ 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'UserCreateDate' => [ 'shape' => 'DateType', ], 'UserLastModifiedDate' => [ 'shape' => 'DateType', ], 'Enabled' => [ 'shape' => 'BooleanType', ], 'UserStatus' => [ 'shape' => 'UserStatusType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], 'PreferredMfaSetting' => [ 'shape' => 'StringType', ], 'UserMFASettingList' => [ 'shape' => 'UserMFASettingListType', ], ], ], 'AdminInitiateAuthRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', 'AuthFlow', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'AuthFlow' => [ 'shape' => 'AuthFlowType', ], 'AuthParameters' => [ 'shape' => 'AuthParametersType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'ContextData' => [ 'shape' => 'ContextDataType', ], ], ], 'AdminInitiateAuthResponse' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeParameters' => [ 'shape' => 'ChallengeParametersType', ], 'AuthenticationResult' => [ 'shape' => 'AuthenticationResultType', ], ], ], 'AdminLinkProviderForUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'DestinationUser', 'SourceUser', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'StringType', ], 'DestinationUser' => [ 'shape' => 'ProviderUserIdentifierType', ], 'SourceUser' => [ 'shape' => 'ProviderUserIdentifierType', ], ], ], 'AdminLinkProviderForUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminListDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'AdminListDevicesResponse' => [ 'type' => 'structure', 'members' => [ 'Devices' => [ 'shape' => 'DeviceListType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'AdminListGroupsForUserRequest' => [ 'type' => 'structure', 'required' => [ 'Username', 'UserPoolId', ], 'members' => [ 'Username' => [ 'shape' => 'UsernameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'AdminListGroupsForUserResponse' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'GroupListType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'AdminListUserAuthEventsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'MaxResults' => [ 'shape' => 'QueryLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'AdminListUserAuthEventsResponse' => [ 'type' => 'structure', 'members' => [ 'AuthEvents' => [ 'shape' => 'AuthEventsType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'AdminRemoveUserFromGroupRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'GroupName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'GroupName' => [ 'shape' => 'GroupNameType', ], ], ], 'AdminResetUserPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminResetUserPasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminRespondToAuthChallengeRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', 'ChallengeName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'ChallengeResponses' => [ 'shape' => 'ChallengeResponsesType', ], 'Session' => [ 'shape' => 'SessionType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'ContextData' => [ 'shape' => 'ContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminRespondToAuthChallengeResponse' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeParameters' => [ 'shape' => 'ChallengeParametersType', ], 'AuthenticationResult' => [ 'shape' => 'AuthenticationResultType', ], ], ], 'AdminSetUserMFAPreferenceRequest' => [ 'type' => 'structure', 'required' => [ 'Username', 'UserPoolId', ], 'members' => [ 'SMSMfaSettings' => [ 'shape' => 'SMSMfaSettingsType', ], 'SoftwareTokenMfaSettings' => [ 'shape' => 'SoftwareTokenMfaSettingsType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'AdminSetUserMFAPreferenceResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminSetUserPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'Password', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'Password' => [ 'shape' => 'PasswordType', ], 'Permanent' => [ 'shape' => 'BooleanType', ], ], ], 'AdminSetUserPasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminSetUserSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'MFAOptions', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], ], ], 'AdminSetUserSettingsResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminUpdateAuthEventFeedbackRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'EventId', 'FeedbackValue', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'EventId' => [ 'shape' => 'EventIdType', ], 'FeedbackValue' => [ 'shape' => 'FeedbackValueType', ], ], ], 'AdminUpdateAuthEventFeedbackResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminUpdateDeviceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'DeviceKey', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceRememberedStatus' => [ 'shape' => 'DeviceRememberedStatusType', ], ], ], 'AdminUpdateDeviceStatusResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminUpdateUserAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'UserAttributes', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminUpdateUserAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminUserGlobalSignOutRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminUserGlobalSignOutResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdvancedSecurityModeType' => [ 'type' => 'string', 'enum' => [ 'OFF', 'AUDIT', 'ENFORCED', ], ], 'AliasAttributeType' => [ 'type' => 'string', 'enum' => [ 'phone_number', 'email', 'preferred_username', ], ], 'AliasAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AliasAttributeType', ], ], 'AliasExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'AnalyticsConfigurationType' => [ 'type' => 'structure', 'members' => [ 'ApplicationId' => [ 'shape' => 'HexStringType', ], 'ApplicationArn' => [ 'shape' => 'ArnType', ], 'RoleArn' => [ 'shape' => 'ArnType', ], 'ExternalId' => [ 'shape' => 'StringType', ], 'UserDataShared' => [ 'shape' => 'BooleanType', ], ], ], 'AnalyticsMetadataType' => [ 'type' => 'structure', 'members' => [ 'AnalyticsEndpointId' => [ 'shape' => 'StringType', ], ], ], 'ArnType' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?', ], 'AssociateSoftwareTokenRequest' => [ 'type' => 'structure', 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'Session' => [ 'shape' => 'SessionType', ], ], ], 'AssociateSoftwareTokenResponse' => [ 'type' => 'structure', 'members' => [ 'SecretCode' => [ 'shape' => 'SecretCodeType', ], 'Session' => [ 'shape' => 'SessionType', ], ], ], 'AttributeDataType' => [ 'type' => 'string', 'enum' => [ 'String', 'Number', 'DateTime', 'Boolean', ], ], 'AttributeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeType', ], ], 'AttributeMappingKeyType' => [ 'type' => 'string', 'max' => 32, 'min' => 1, ], 'AttributeMappingType' => [ 'type' => 'map', 'key' => [ 'shape' => 'AttributeMappingKeyType', ], 'value' => [ 'shape' => 'StringType', ], ], 'AttributeNameListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeNameType', ], ], 'AttributeNameType' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'AttributeType' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'AttributeNameType', ], 'Value' => [ 'shape' => 'AttributeValueType', ], ], ], 'AttributeValueType' => [ 'type' => 'string', 'max' => 2048, 'sensitive' => true, ], 'AttributesRequireVerificationBeforeUpdateType' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedAttributeType', ], ], 'AuthEventType' => [ 'type' => 'structure', 'members' => [ 'EventId' => [ 'shape' => 'StringType', ], 'EventType' => [ 'shape' => 'EventType', ], 'CreationDate' => [ 'shape' => 'DateType', ], 'EventResponse' => [ 'shape' => 'EventResponseType', ], 'EventRisk' => [ 'shape' => 'EventRiskType', ], 'ChallengeResponses' => [ 'shape' => 'ChallengeResponseListType', ], 'EventContextData' => [ 'shape' => 'EventContextDataType', ], 'EventFeedback' => [ 'shape' => 'EventFeedbackType', ], ], ], 'AuthEventsType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthEventType', ], ], 'AuthFlowType' => [ 'type' => 'string', 'enum' => [ 'USER_SRP_AUTH', 'REFRESH_TOKEN_AUTH', 'REFRESH_TOKEN', 'CUSTOM_AUTH', 'ADMIN_NO_SRP_AUTH', 'USER_PASSWORD_AUTH', 'ADMIN_USER_PASSWORD_AUTH', ], ], 'AuthParametersType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], 'sensitive' => true, ], 'AuthSessionValidityType' => [ 'type' => 'integer', 'max' => 15, 'min' => 3, ], 'AuthenticationResultType' => [ 'type' => 'structure', 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'ExpiresIn' => [ 'shape' => 'IntegerType', ], 'TokenType' => [ 'shape' => 'StringType', ], 'RefreshToken' => [ 'shape' => 'TokenModelType', ], 'IdToken' => [ 'shape' => 'TokenModelType', ], 'NewDeviceMetadata' => [ 'shape' => 'NewDeviceMetadataType', ], ], ], 'BlockedIPRangeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringType', ], 'max' => 200, ], 'BooleanType' => [ 'type' => 'boolean', ], 'CSSType' => [ 'type' => 'string', ], 'CSSVersionType' => [ 'type' => 'string', ], 'CallbackURLsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'RedirectUrlType', ], 'max' => 100, 'min' => 0, ], 'ChallengeName' => [ 'type' => 'string', 'enum' => [ 'Password', 'Mfa', ], ], 'ChallengeNameType' => [ 'type' => 'string', 'enum' => [ 'SMS_MFA', 'SOFTWARE_TOKEN_MFA', 'SELECT_MFA_TYPE', 'MFA_SETUP', 'PASSWORD_VERIFIER', 'CUSTOM_CHALLENGE', 'DEVICE_SRP_AUTH', 'DEVICE_PASSWORD_VERIFIER', 'ADMIN_NO_SRP_AUTH', 'NEW_PASSWORD_REQUIRED', ], ], 'ChallengeParametersType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], ], 'ChallengeResponse' => [ 'type' => 'string', 'enum' => [ 'Success', 'Failure', ], ], 'ChallengeResponseListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChallengeResponseType', ], ], 'ChallengeResponseType' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeName', ], 'ChallengeResponse' => [ 'shape' => 'ChallengeResponse', ], ], ], 'ChallengeResponsesType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], 'sensitive' => true, ], 'ChangePasswordRequest' => [ 'type' => 'structure', 'required' => [ 'PreviousPassword', 'ProposedPassword', 'AccessToken', ], 'members' => [ 'PreviousPassword' => [ 'shape' => 'PasswordType', ], 'ProposedPassword' => [ 'shape' => 'PasswordType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'ChangePasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'ClientIdType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w+]+', 'sensitive' => true, ], 'ClientMetadataType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], ], 'ClientNameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w\\s+=,.@-]+', ], 'ClientPermissionListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClientPermissionType', ], ], 'ClientPermissionType' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'ClientSecretType' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\w+]+', 'sensitive' => true, ], 'CodeDeliveryDetailsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeDeliveryDetailsType', ], ], 'CodeDeliveryDetailsType' => [ 'type' => 'structure', 'members' => [ 'Destination' => [ 'shape' => 'StringType', ], 'DeliveryMedium' => [ 'shape' => 'DeliveryMediumType', ], 'AttributeName' => [ 'shape' => 'AttributeNameType', ], ], ], 'CodeDeliveryFailureException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'CodeMismatchException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'CompletionMessageType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w]+', ], 'CompromisedCredentialsActionsType' => [ 'type' => 'structure', 'required' => [ 'EventAction', ], 'members' => [ 'EventAction' => [ 'shape' => 'CompromisedCredentialsEventActionType', ], ], ], 'CompromisedCredentialsEventActionType' => [ 'type' => 'string', 'enum' => [ 'BLOCK', 'NO_ACTION', ], ], 'CompromisedCredentialsRiskConfigurationType' => [ 'type' => 'structure', 'required' => [ 'Actions', ], 'members' => [ 'EventFilter' => [ 'shape' => 'EventFiltersType', ], 'Actions' => [ 'shape' => 'CompromisedCredentialsActionsType', ], ], ], 'ConcurrentModificationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ConfirmDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'DeviceKey', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceSecretVerifierConfig' => [ 'shape' => 'DeviceSecretVerifierConfigType', ], 'DeviceName' => [ 'shape' => 'DeviceNameType', ], ], ], 'ConfirmDeviceResponse' => [ 'type' => 'structure', 'members' => [ 'UserConfirmationNecessary' => [ 'shape' => 'BooleanType', ], ], ], 'ConfirmForgotPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', 'ConfirmationCode', 'Password', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'ConfirmationCode' => [ 'shape' => 'ConfirmationCodeType', ], 'Password' => [ 'shape' => 'PasswordType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'ConfirmForgotPasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'ConfirmSignUpRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', 'ConfirmationCode', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'ConfirmationCode' => [ 'shape' => 'ConfirmationCodeType', ], 'ForceAliasCreation' => [ 'shape' => 'ForceAliasCreation', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'ConfirmSignUpResponse' => [ 'type' => 'structure', 'members' => [], ], 'ConfirmationCodeType' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[\\S]+', ], 'ContextDataType' => [ 'type' => 'structure', 'required' => [ 'IpAddress', 'ServerName', 'ServerPath', 'HttpHeaders', ], 'members' => [ 'IpAddress' => [ 'shape' => 'StringType', ], 'ServerName' => [ 'shape' => 'StringType', ], 'ServerPath' => [ 'shape' => 'StringType', ], 'HttpHeaders' => [ 'shape' => 'HttpHeaderList', ], 'EncodedData' => [ 'shape' => 'StringType', ], ], ], 'CreateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'UserPoolId', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Description' => [ 'shape' => 'DescriptionType', ], 'RoleArn' => [ 'shape' => 'ArnType', ], 'Precedence' => [ 'shape' => 'PrecedenceType', ], ], ], 'CreateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'GroupType', ], ], ], 'CreateIdentityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ProviderName', 'ProviderType', 'ProviderDetails', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameTypeV1', ], 'ProviderType' => [ 'shape' => 'IdentityProviderTypeType', ], 'ProviderDetails' => [ 'shape' => 'ProviderDetailsType', ], 'AttributeMapping' => [ 'shape' => 'AttributeMappingType', ], 'IdpIdentifiers' => [ 'shape' => 'IdpIdentifiersListType', ], ], ], 'CreateIdentityProviderResponse' => [ 'type' => 'structure', 'required' => [ 'IdentityProvider', ], 'members' => [ 'IdentityProvider' => [ 'shape' => 'IdentityProviderType', ], ], ], 'CreateResourceServerRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Identifier', 'Name', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], 'Name' => [ 'shape' => 'ResourceServerNameType', ], 'Scopes' => [ 'shape' => 'ResourceServerScopeListType', ], ], ], 'CreateResourceServerResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceServer', ], 'members' => [ 'ResourceServer' => [ 'shape' => 'ResourceServerType', ], ], ], 'CreateUserImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', 'UserPoolId', 'CloudWatchLogsRoleArn', ], 'members' => [ 'JobName' => [ 'shape' => 'UserImportJobNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CloudWatchLogsRoleArn' => [ 'shape' => 'ArnType', ], ], ], 'CreateUserImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJob' => [ 'shape' => 'UserImportJobType', ], ], ], 'CreateUserPoolClientRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientName' => [ 'shape' => 'ClientNameType', ], 'GenerateSecret' => [ 'shape' => 'GenerateSecret', ], 'RefreshTokenValidity' => [ 'shape' => 'RefreshTokenValidityType', ], 'AccessTokenValidity' => [ 'shape' => 'AccessTokenValidityType', ], 'IdTokenValidity' => [ 'shape' => 'IdTokenValidityType', ], 'TokenValidityUnits' => [ 'shape' => 'TokenValidityUnitsType', ], 'ReadAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'WriteAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'ExplicitAuthFlows' => [ 'shape' => 'ExplicitAuthFlowsListType', ], 'SupportedIdentityProviders' => [ 'shape' => 'SupportedIdentityProvidersListType', ], 'CallbackURLs' => [ 'shape' => 'CallbackURLsListType', ], 'LogoutURLs' => [ 'shape' => 'LogoutURLsListType', ], 'DefaultRedirectURI' => [ 'shape' => 'RedirectUrlType', ], 'AllowedOAuthFlows' => [ 'shape' => 'OAuthFlowsType', ], 'AllowedOAuthScopes' => [ 'shape' => 'ScopeListType', ], 'AllowedOAuthFlowsUserPoolClient' => [ 'shape' => 'BooleanType', ], 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfigurationType', ], 'PreventUserExistenceErrors' => [ 'shape' => 'PreventUserExistenceErrorTypes', ], 'EnableTokenRevocation' => [ 'shape' => 'WrappedBooleanType', ], 'EnablePropagateAdditionalUserContextData' => [ 'shape' => 'WrappedBooleanType', ], 'AuthSessionValidity' => [ 'shape' => 'AuthSessionValidityType', ], ], ], 'CreateUserPoolClientResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolClient' => [ 'shape' => 'UserPoolClientType', ], ], ], 'CreateUserPoolDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Domain', 'UserPoolId', ], 'members' => [ 'Domain' => [ 'shape' => 'DomainType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CustomDomainConfig' => [ 'shape' => 'CustomDomainConfigType', ], ], ], 'CreateUserPoolDomainResponse' => [ 'type' => 'structure', 'members' => [ 'CloudFrontDomain' => [ 'shape' => 'DomainType', ], ], ], 'CreateUserPoolRequest' => [ 'type' => 'structure', 'required' => [ 'PoolName', ], 'members' => [ 'PoolName' => [ 'shape' => 'UserPoolNameType', ], 'Policies' => [ 'shape' => 'UserPoolPolicyType', ], 'DeletionProtection' => [ 'shape' => 'DeletionProtectionType', ], 'LambdaConfig' => [ 'shape' => 'LambdaConfigType', ], 'AutoVerifiedAttributes' => [ 'shape' => 'VerifiedAttributesListType', ], 'AliasAttributes' => [ 'shape' => 'AliasAttributesListType', ], 'UsernameAttributes' => [ 'shape' => 'UsernameAttributesListType', ], 'SmsVerificationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailVerificationMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailVerificationSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], 'VerificationMessageTemplate' => [ 'shape' => 'VerificationMessageTemplateType', ], 'SmsAuthenticationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], 'UserAttributeUpdateSettings' => [ 'shape' => 'UserAttributeUpdateSettingsType', ], 'DeviceConfiguration' => [ 'shape' => 'DeviceConfigurationType', ], 'EmailConfiguration' => [ 'shape' => 'EmailConfigurationType', ], 'SmsConfiguration' => [ 'shape' => 'SmsConfigurationType', ], 'UserPoolTags' => [ 'shape' => 'UserPoolTagsType', ], 'AdminCreateUserConfig' => [ 'shape' => 'AdminCreateUserConfigType', ], 'Schema' => [ 'shape' => 'SchemaAttributesListType', ], 'UserPoolAddOns' => [ 'shape' => 'UserPoolAddOnsType', ], 'UsernameConfiguration' => [ 'shape' => 'UsernameConfigurationType', ], 'AccountRecoverySetting' => [ 'shape' => 'AccountRecoverySettingType', ], ], ], 'CreateUserPoolResponse' => [ 'type' => 'structure', 'members' => [ 'UserPool' => [ 'shape' => 'UserPoolType', ], ], ], 'CustomAttributeNameType' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'CustomAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'SchemaAttributeType', ], 'max' => 25, 'min' => 1, ], 'CustomDomainConfigType' => [ 'type' => 'structure', 'required' => [ 'CertificateArn', ], 'members' => [ 'CertificateArn' => [ 'shape' => 'ArnType', ], ], ], 'CustomEmailLambdaVersionConfigType' => [ 'type' => 'structure', 'required' => [ 'LambdaVersion', 'LambdaArn', ], 'members' => [ 'LambdaVersion' => [ 'shape' => 'CustomEmailSenderLambdaVersionType', ], 'LambdaArn' => [ 'shape' => 'ArnType', ], ], ], 'CustomEmailSenderLambdaVersionType' => [ 'type' => 'string', 'enum' => [ 'V1_0', ], ], 'CustomSMSLambdaVersionConfigType' => [ 'type' => 'structure', 'required' => [ 'LambdaVersion', 'LambdaArn', ], 'members' => [ 'LambdaVersion' => [ 'shape' => 'CustomSMSSenderLambdaVersionType', ], 'LambdaArn' => [ 'shape' => 'ArnType', ], ], ], 'CustomSMSSenderLambdaVersionType' => [ 'type' => 'string', 'enum' => [ 'V1_0', ], ], 'DateType' => [ 'type' => 'timestamp', ], 'DefaultEmailOptionType' => [ 'type' => 'string', 'enum' => [ 'CONFIRM_WITH_LINK', 'CONFIRM_WITH_CODE', ], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'UserPoolId', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'DeleteIdentityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ProviderName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameType', ], ], ], 'DeleteResourceServerRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Identifier', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], ], ], 'DeleteUserAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserAttributeNames', 'AccessToken', ], 'members' => [ 'UserAttributeNames' => [ 'shape' => 'AttributeNameListType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'DeleteUserAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUserPoolClientRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], ], ], 'DeleteUserPoolDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Domain', 'UserPoolId', ], 'members' => [ 'Domain' => [ 'shape' => 'DomainType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'DeleteUserPoolDomainResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUserPoolRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'DeletionProtectionType' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'DeliveryMediumListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeliveryMediumType', ], ], 'DeliveryMediumType' => [ 'type' => 'string', 'enum' => [ 'SMS', 'EMAIL', ], ], 'DescribeIdentityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ProviderName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameType', ], ], ], 'DescribeIdentityProviderResponse' => [ 'type' => 'structure', 'required' => [ 'IdentityProvider', ], 'members' => [ 'IdentityProvider' => [ 'shape' => 'IdentityProviderType', ], ], ], 'DescribeResourceServerRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Identifier', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], ], ], 'DescribeResourceServerResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceServer', ], 'members' => [ 'ResourceServer' => [ 'shape' => 'ResourceServerType', ], ], ], 'DescribeRiskConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], ], ], 'DescribeRiskConfigurationResponse' => [ 'type' => 'structure', 'required' => [ 'RiskConfiguration', ], 'members' => [ 'RiskConfiguration' => [ 'shape' => 'RiskConfigurationType', ], ], ], 'DescribeUserImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'JobId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'JobId' => [ 'shape' => 'UserImportJobIdType', ], ], ], 'DescribeUserImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJob' => [ 'shape' => 'UserImportJobType', ], ], ], 'DescribeUserPoolClientRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], ], ], 'DescribeUserPoolClientResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolClient' => [ 'shape' => 'UserPoolClientType', ], ], ], 'DescribeUserPoolDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Domain', ], 'members' => [ 'Domain' => [ 'shape' => 'DomainType', ], ], ], 'DescribeUserPoolDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainDescription' => [ 'shape' => 'DomainDescriptionType', ], ], ], 'DescribeUserPoolRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'DescribeUserPoolResponse' => [ 'type' => 'structure', 'members' => [ 'UserPool' => [ 'shape' => 'UserPoolType', ], ], ], 'DescriptionType' => [ 'type' => 'string', 'max' => 2048, ], 'DeviceConfigurationType' => [ 'type' => 'structure', 'members' => [ 'ChallengeRequiredOnNewDevice' => [ 'shape' => 'BooleanType', ], 'DeviceOnlyRememberedOnUserPrompt' => [ 'shape' => 'BooleanType', ], ], ], 'DeviceKeyType' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-f-]+', ], 'DeviceListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceType', ], ], 'DeviceNameType' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'DeviceRememberedStatusType' => [ 'type' => 'string', 'enum' => [ 'remembered', 'not_remembered', ], ], 'DeviceSecretVerifierConfigType' => [ 'type' => 'structure', 'members' => [ 'PasswordVerifier' => [ 'shape' => 'StringType', ], 'Salt' => [ 'shape' => 'StringType', ], ], ], 'DeviceType' => [ 'type' => 'structure', 'members' => [ 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceAttributes' => [ 'shape' => 'AttributeListType', ], 'DeviceCreateDate' => [ 'shape' => 'DateType', ], 'DeviceLastModifiedDate' => [ 'shape' => 'DateType', ], 'DeviceLastAuthenticatedDate' => [ 'shape' => 'DateType', ], ], ], 'DomainDescriptionType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'AWSAccountId' => [ 'shape' => 'AWSAccountIdType', ], 'Domain' => [ 'shape' => 'DomainType', ], 'S3Bucket' => [ 'shape' => 'S3BucketType', ], 'CloudFrontDistribution' => [ 'shape' => 'StringType', ], 'Version' => [ 'shape' => 'DomainVersionType', ], 'Status' => [ 'shape' => 'DomainStatusType', ], 'CustomDomainConfig' => [ 'shape' => 'CustomDomainConfigType', ], ], ], 'DomainStatusType' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'DELETING', 'UPDATING', 'ACTIVE', 'FAILED', ], ], 'DomainType' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$', ], 'DomainVersionType' => [ 'type' => 'string', 'max' => 20, 'min' => 1, ], 'DuplicateProviderException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'EmailAddressType' => [ 'type' => 'string', 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+@[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'EmailConfigurationType' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'ArnType', ], 'ReplyToEmailAddress' => [ 'shape' => 'EmailAddressType', ], 'EmailSendingAccount' => [ 'shape' => 'EmailSendingAccountType', ], 'From' => [ 'shape' => 'StringType', ], 'ConfigurationSet' => [ 'shape' => 'SESConfigurationSet', ], ], ], 'EmailNotificationBodyType' => [ 'type' => 'string', 'max' => 20000, 'min' => 6, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]+', ], 'EmailNotificationSubjectType' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+', ], 'EmailSendingAccountType' => [ 'type' => 'string', 'enum' => [ 'COGNITO_DEFAULT', 'DEVELOPER', ], ], 'EmailVerificationMessageByLinkType' => [ 'type' => 'string', 'max' => 20000, 'min' => 6, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*', ], 'EmailVerificationMessageType' => [ 'type' => 'string', 'max' => 20000, 'min' => 6, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*', ], 'EmailVerificationSubjectByLinkType' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+', ], 'EmailVerificationSubjectType' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+', ], 'EnableSoftwareTokenMFAException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'EventContextDataType' => [ 'type' => 'structure', 'members' => [ 'IpAddress' => [ 'shape' => 'StringType', ], 'DeviceName' => [ 'shape' => 'StringType', ], 'Timezone' => [ 'shape' => 'StringType', ], 'City' => [ 'shape' => 'StringType', ], 'Country' => [ 'shape' => 'StringType', ], ], ], 'EventFeedbackType' => [ 'type' => 'structure', 'required' => [ 'FeedbackValue', 'Provider', ], 'members' => [ 'FeedbackValue' => [ 'shape' => 'FeedbackValueType', ], 'Provider' => [ 'shape' => 'StringType', ], 'FeedbackDate' => [ 'shape' => 'DateType', ], ], ], 'EventFilterType' => [ 'type' => 'string', 'enum' => [ 'SIGN_IN', 'PASSWORD_CHANGE', 'SIGN_UP', ], ], 'EventFiltersType' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventFilterType', ], ], 'EventIdType' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '[\\w+-]+', ], 'EventResponseType' => [ 'type' => 'string', 'enum' => [ 'Pass', 'Fail', 'InProgress', ], ], 'EventRiskType' => [ 'type' => 'structure', 'members' => [ 'RiskDecision' => [ 'shape' => 'RiskDecisionType', ], 'RiskLevel' => [ 'shape' => 'RiskLevelType', ], 'CompromisedCredentialsDetected' => [ 'shape' => 'WrappedBooleanType', ], ], ], 'EventType' => [ 'type' => 'string', 'enum' => [ 'SignIn', 'SignUp', 'ForgotPassword', 'PasswordChange', 'ResendCode', ], ], 'ExpiredCodeException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ExplicitAuthFlowsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExplicitAuthFlowsType', ], ], 'ExplicitAuthFlowsType' => [ 'type' => 'string', 'enum' => [ 'ADMIN_NO_SRP_AUTH', 'CUSTOM_AUTH_FLOW_ONLY', 'USER_PASSWORD_AUTH', 'ALLOW_ADMIN_USER_PASSWORD_AUTH', 'ALLOW_CUSTOM_AUTH', 'ALLOW_USER_PASSWORD_AUTH', 'ALLOW_USER_SRP_AUTH', 'ALLOW_REFRESH_TOKEN_AUTH', ], ], 'FeedbackValueType' => [ 'type' => 'string', 'enum' => [ 'Valid', 'Invalid', ], ], 'ForbiddenException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ForceAliasCreation' => [ 'type' => 'boolean', ], 'ForgetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceKey', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], ], ], 'ForgotPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'ForgotPasswordResponse' => [ 'type' => 'structure', 'members' => [ 'CodeDeliveryDetails' => [ 'shape' => 'CodeDeliveryDetailsType', ], ], ], 'GenerateSecret' => [ 'type' => 'boolean', ], 'GetCSVHeaderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'GetCSVHeaderResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CSVHeader' => [ 'shape' => 'ListOfStringTypes', ], ], ], 'GetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceKey', ], 'members' => [ 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'GetDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'Device', ], 'members' => [ 'Device' => [ 'shape' => 'DeviceType', ], ], ], 'GetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'UserPoolId', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'GetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'GroupType', ], ], ], 'GetIdentityProviderByIdentifierRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'IdpIdentifier', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'IdpIdentifier' => [ 'shape' => 'IdpIdentifierType', ], ], ], 'GetIdentityProviderByIdentifierResponse' => [ 'type' => 'structure', 'required' => [ 'IdentityProvider', ], 'members' => [ 'IdentityProvider' => [ 'shape' => 'IdentityProviderType', ], ], ], 'GetSigningCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'GetSigningCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'Certificate' => [ 'shape' => 'StringType', ], ], ], 'GetUICustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], ], ], 'GetUICustomizationResponse' => [ 'type' => 'structure', 'required' => [ 'UICustomization', ], 'members' => [ 'UICustomization' => [ 'shape' => 'UICustomizationType', ], ], ], 'GetUserAttributeVerificationCodeRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'AttributeName', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'AttributeName' => [ 'shape' => 'AttributeNameType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'GetUserAttributeVerificationCodeResponse' => [ 'type' => 'structure', 'members' => [ 'CodeDeliveryDetails' => [ 'shape' => 'CodeDeliveryDetailsType', ], ], ], 'GetUserPoolMfaConfigRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'GetUserPoolMfaConfigResponse' => [ 'type' => 'structure', 'members' => [ 'SmsMfaConfiguration' => [ 'shape' => 'SmsMfaConfigType', ], 'SoftwareTokenMfaConfiguration' => [ 'shape' => 'SoftwareTokenMfaConfigType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], ], ], 'GetUserRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'GetUserResponse' => [ 'type' => 'structure', 'required' => [ 'Username', 'UserAttributes', ], 'members' => [ 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], 'PreferredMfaSetting' => [ 'shape' => 'StringType', ], 'UserMFASettingList' => [ 'shape' => 'UserMFASettingListType', ], ], ], 'GlobalSignOutRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'GlobalSignOutResponse' => [ 'type' => 'structure', 'members' => [], ], 'GroupExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'GroupListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupType', ], ], 'GroupNameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'GroupType' => [ 'type' => 'structure', 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Description' => [ 'shape' => 'DescriptionType', ], 'RoleArn' => [ 'shape' => 'ArnType', ], 'Precedence' => [ 'shape' => 'PrecedenceType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'HexStringType' => [ 'type' => 'string', 'pattern' => '^[0-9a-fA-F]+$', ], 'HttpHeader' => [ 'type' => 'structure', 'members' => [ 'headerName' => [ 'shape' => 'StringType', ], 'headerValue' => [ 'shape' => 'StringType', ], ], ], 'HttpHeaderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HttpHeader', ], ], 'IdTokenValidityType' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'IdentityProviderType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameType', ], 'ProviderType' => [ 'shape' => 'IdentityProviderTypeType', ], 'ProviderDetails' => [ 'shape' => 'ProviderDetailsType', ], 'AttributeMapping' => [ 'shape' => 'AttributeMappingType', ], 'IdpIdentifiers' => [ 'shape' => 'IdpIdentifiersListType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'IdentityProviderTypeType' => [ 'type' => 'string', 'enum' => [ 'SAML', 'Facebook', 'Google', 'LoginWithAmazon', 'SignInWithApple', 'OIDC', ], ], 'IdpIdentifierType' => [ 'type' => 'string', 'max' => 40, 'min' => 1, 'pattern' => '[\\w\\s+=.@-]+', ], 'IdpIdentifiersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'IdpIdentifierType', ], 'max' => 50, 'min' => 0, ], 'ImageFileType' => [ 'type' => 'blob', ], 'ImageUrlType' => [ 'type' => 'string', ], 'InitiateAuthRequest' => [ 'type' => 'structure', 'required' => [ 'AuthFlow', 'ClientId', ], 'members' => [ 'AuthFlow' => [ 'shape' => 'AuthFlowType', ], 'AuthParameters' => [ 'shape' => 'AuthParametersType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], ], ], 'InitiateAuthResponse' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeParameters' => [ 'shape' => 'ChallengeParametersType', ], 'AuthenticationResult' => [ 'shape' => 'AuthenticationResultType', ], ], ], 'IntegerType' => [ 'type' => 'integer', ], 'InternalErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, 'fault' => true, ], 'InvalidEmailRoleAccessPolicyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidLambdaResponseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidOAuthFlowException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidPasswordException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidSmsRoleAccessPolicyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidSmsRoleTrustRelationshipException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidUserPoolConfigurationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'LambdaConfigType' => [ 'type' => 'structure', 'members' => [ 'PreSignUp' => [ 'shape' => 'ArnType', ], 'CustomMessage' => [ 'shape' => 'ArnType', ], 'PostConfirmation' => [ 'shape' => 'ArnType', ], 'PreAuthentication' => [ 'shape' => 'ArnType', ], 'PostAuthentication' => [ 'shape' => 'ArnType', ], 'DefineAuthChallenge' => [ 'shape' => 'ArnType', ], 'CreateAuthChallenge' => [ 'shape' => 'ArnType', ], 'VerifyAuthChallengeResponse' => [ 'shape' => 'ArnType', ], 'PreTokenGeneration' => [ 'shape' => 'ArnType', ], 'UserMigration' => [ 'shape' => 'ArnType', ], 'CustomSMSSender' => [ 'shape' => 'CustomSMSLambdaVersionConfigType', ], 'CustomEmailSender' => [ 'shape' => 'CustomEmailLambdaVersionConfigType', ], 'KMSKeyID' => [ 'shape' => 'ArnType', ], ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ListDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'ListDevicesResponse' => [ 'type' => 'structure', 'members' => [ 'Devices' => [ 'shape' => 'DeviceListType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'GroupListType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListIdentityProvidersRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'MaxResults' => [ 'shape' => 'ListProvidersLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListIdentityProvidersResponse' => [ 'type' => 'structure', 'required' => [ 'Providers', ], 'members' => [ 'Providers' => [ 'shape' => 'ProvidersListType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListOfStringTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringType', ], ], 'ListProvidersLimitType' => [ 'type' => 'integer', 'max' => 60, 'min' => 0, ], 'ListResourceServersLimitType' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListResourceServersRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'MaxResults' => [ 'shape' => 'ListResourceServersLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListResourceServersResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceServers', ], 'members' => [ 'ResourceServers' => [ 'shape' => 'ResourceServersListType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ArnType', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'UserPoolTagsType', ], ], ], 'ListUserImportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'MaxResults', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'MaxResults' => [ 'shape' => 'PoolQueryLimitType', ], 'PaginationToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListUserImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJobs' => [ 'shape' => 'UserImportJobsListType', ], 'PaginationToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListUserPoolClientsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'MaxResults' => [ 'shape' => 'QueryLimit', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListUserPoolClientsResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolClients' => [ 'shape' => 'UserPoolClientListType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListUserPoolsRequest' => [ 'type' => 'structure', 'required' => [ 'MaxResults', ], 'members' => [ 'NextToken' => [ 'shape' => 'PaginationKeyType', ], 'MaxResults' => [ 'shape' => 'PoolQueryLimitType', ], ], ], 'ListUserPoolsResponse' => [ 'type' => 'structure', 'members' => [ 'UserPools' => [ 'shape' => 'UserPoolListType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListUsersInGroupRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'GroupName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'GroupName' => [ 'shape' => 'GroupNameType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListUsersInGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'UsersListType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListUsersRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'AttributesToGet' => [ 'shape' => 'SearchedAttributeNamesListType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], 'Filter' => [ 'shape' => 'UserFilterType', ], ], ], 'ListUsersResponse' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'UsersListType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'LogoutURLsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'RedirectUrlType', ], 'max' => 100, 'min' => 0, ], 'LongType' => [ 'type' => 'long', ], 'MFAMethodNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'MFAOptionListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'MFAOptionType', ], ], 'MFAOptionType' => [ 'type' => 'structure', 'members' => [ 'DeliveryMedium' => [ 'shape' => 'DeliveryMediumType', ], 'AttributeName' => [ 'shape' => 'AttributeNameType', ], ], ], 'MessageActionType' => [ 'type' => 'string', 'enum' => [ 'RESEND', 'SUPPRESS', ], ], 'MessageTemplateType' => [ 'type' => 'structure', 'members' => [ 'SMSMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], ], ], 'MessageType' => [ 'type' => 'string', ], 'NewDeviceMetadataType' => [ 'type' => 'structure', 'members' => [ 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceGroupKey' => [ 'shape' => 'StringType', ], ], ], 'NotAuthorizedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'NotifyConfigurationType' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'From' => [ 'shape' => 'StringType', ], 'ReplyTo' => [ 'shape' => 'StringType', ], 'SourceArn' => [ 'shape' => 'ArnType', ], 'BlockEmail' => [ 'shape' => 'NotifyEmailType', ], 'NoActionEmail' => [ 'shape' => 'NotifyEmailType', ], 'MfaEmail' => [ 'shape' => 'NotifyEmailType', ], ], ], 'NotifyEmailType' => [ 'type' => 'structure', 'required' => [ 'Subject', ], 'members' => [ 'Subject' => [ 'shape' => 'EmailNotificationSubjectType', ], 'HtmlBody' => [ 'shape' => 'EmailNotificationBodyType', ], 'TextBody' => [ 'shape' => 'EmailNotificationBodyType', ], ], ], 'NumberAttributeConstraintsType' => [ 'type' => 'structure', 'members' => [ 'MinValue' => [ 'shape' => 'StringType', ], 'MaxValue' => [ 'shape' => 'StringType', ], ], ], 'OAuthFlowType' => [ 'type' => 'string', 'enum' => [ 'code', 'implicit', 'client_credentials', ], ], 'OAuthFlowsType' => [ 'type' => 'list', 'member' => [ 'shape' => 'OAuthFlowType', ], 'max' => 3, 'min' => 0, ], 'PaginationKey' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\S]+', ], 'PaginationKeyType' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\S]+', ], 'PasswordPolicyMinLengthType' => [ 'type' => 'integer', 'max' => 99, 'min' => 6, ], 'PasswordPolicyType' => [ 'type' => 'structure', 'members' => [ 'MinimumLength' => [ 'shape' => 'PasswordPolicyMinLengthType', ], 'RequireUppercase' => [ 'shape' => 'BooleanType', ], 'RequireLowercase' => [ 'shape' => 'BooleanType', ], 'RequireNumbers' => [ 'shape' => 'BooleanType', ], 'RequireSymbols' => [ 'shape' => 'BooleanType', ], 'TemporaryPasswordValidityDays' => [ 'shape' => 'TemporaryPasswordValidityDaysType', ], ], ], 'PasswordResetRequiredException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'PasswordType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\S]+', 'sensitive' => true, ], 'PoolQueryLimitType' => [ 'type' => 'integer', 'max' => 60, 'min' => 1, ], 'PreSignedUrlType' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'PrecedenceType' => [ 'type' => 'integer', 'min' => 0, ], 'PreconditionNotMetException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'PreventUserExistenceErrorTypes' => [ 'type' => 'string', 'enum' => [ 'LEGACY', 'ENABLED', ], ], 'PriorityType' => [ 'type' => 'integer', 'max' => 2, 'min' => 1, ], 'ProviderDescription' => [ 'type' => 'structure', 'members' => [ 'ProviderName' => [ 'shape' => 'ProviderNameType', ], 'ProviderType' => [ 'shape' => 'IdentityProviderTypeType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'ProviderDetailsType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], ], 'ProviderNameType' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'ProviderNameTypeV1' => [ 'type' => 'string', 'max' => 32, 'min' => 3, 'pattern' => '[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+', ], 'ProviderUserIdentifierType' => [ 'type' => 'structure', 'members' => [ 'ProviderName' => [ 'shape' => 'ProviderNameType', ], 'ProviderAttributeName' => [ 'shape' => 'StringType', ], 'ProviderAttributeValue' => [ 'shape' => 'StringType', ], ], ], 'ProvidersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProviderDescription', ], 'max' => 50, 'min' => 0, ], 'QueryLimit' => [ 'type' => 'integer', 'max' => 60, 'min' => 1, ], 'QueryLimitType' => [ 'type' => 'integer', 'max' => 60, 'min' => 0, ], 'RecoveryMechanismsType' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecoveryOptionType', ], 'max' => 2, 'min' => 1, ], 'RecoveryOptionNameType' => [ 'type' => 'string', 'enum' => [ 'verified_email', 'verified_phone_number', 'admin_only', ], ], 'RecoveryOptionType' => [ 'type' => 'structure', 'required' => [ 'Priority', 'Name', ], 'members' => [ 'Priority' => [ 'shape' => 'PriorityType', ], 'Name' => [ 'shape' => 'RecoveryOptionNameType', ], ], ], 'RedirectUrlType' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'RefreshTokenValidityType' => [ 'type' => 'integer', 'max' => 315360000, 'min' => 0, ], 'RegionCodeType' => [ 'type' => 'string', 'max' => 32, 'min' => 5, ], 'ResendConfirmationCodeRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'ResendConfirmationCodeResponse' => [ 'type' => 'structure', 'members' => [ 'CodeDeliveryDetails' => [ 'shape' => 'CodeDeliveryDetailsType', ], ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ResourceServerIdentifierType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\x21\\x23-\\x5B\\x5D-\\x7E]+', ], 'ResourceServerNameType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\w\\s+=,.@-]+', ], 'ResourceServerScopeDescriptionType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ResourceServerScopeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceServerScopeType', ], 'max' => 100, ], 'ResourceServerScopeNameType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\x21\\x23-\\x2E\\x30-\\x5B\\x5D-\\x7E]+', ], 'ResourceServerScopeType' => [ 'type' => 'structure', 'required' => [ 'ScopeName', 'ScopeDescription', ], 'members' => [ 'ScopeName' => [ 'shape' => 'ResourceServerScopeNameType', ], 'ScopeDescription' => [ 'shape' => 'ResourceServerScopeDescriptionType', ], ], ], 'ResourceServerType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], 'Name' => [ 'shape' => 'ResourceServerNameType', ], 'Scopes' => [ 'shape' => 'ResourceServerScopeListType', ], ], ], 'ResourceServersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceServerType', ], ], 'RespondToAuthChallengeRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'ChallengeName', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeResponses' => [ 'shape' => 'ChallengeResponsesType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'RespondToAuthChallengeResponse' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeParameters' => [ 'shape' => 'ChallengeParametersType', ], 'AuthenticationResult' => [ 'shape' => 'AuthenticationResultType', ], ], ], 'RevokeTokenRequest' => [ 'type' => 'structure', 'required' => [ 'Token', 'ClientId', ], 'members' => [ 'Token' => [ 'shape' => 'TokenModelType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ClientSecret' => [ 'shape' => 'ClientSecretType', ], ], ], 'RevokeTokenResponse' => [ 'type' => 'structure', 'members' => [], ], 'RiskConfigurationType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'CompromisedCredentialsRiskConfiguration' => [ 'shape' => 'CompromisedCredentialsRiskConfigurationType', ], 'AccountTakeoverRiskConfiguration' => [ 'shape' => 'AccountTakeoverRiskConfigurationType', ], 'RiskExceptionConfiguration' => [ 'shape' => 'RiskExceptionConfigurationType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], ], ], 'RiskDecisionType' => [ 'type' => 'string', 'enum' => [ 'NoRisk', 'AccountTakeover', 'Block', ], ], 'RiskExceptionConfigurationType' => [ 'type' => 'structure', 'members' => [ 'BlockedIPRangeList' => [ 'shape' => 'BlockedIPRangeListType', ], 'SkippedIPRangeList' => [ 'shape' => 'SkippedIPRangeListType', ], ], ], 'RiskLevelType' => [ 'type' => 'string', 'enum' => [ 'Low', 'Medium', 'High', ], ], 'S3BucketType' => [ 'type' => 'string', 'max' => 1024, 'min' => 3, 'pattern' => '^[0-9A-Za-z\\.\\-_]*(? [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_-]+$', ], 'SMSMfaSettingsType' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'BooleanType', ], 'PreferredMfa' => [ 'shape' => 'BooleanType', ], ], ], 'SchemaAttributeType' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'CustomAttributeNameType', ], 'AttributeDataType' => [ 'shape' => 'AttributeDataType', ], 'DeveloperOnlyAttribute' => [ 'shape' => 'BooleanType', 'box' => true, ], 'Mutable' => [ 'shape' => 'BooleanType', 'box' => true, ], 'Required' => [ 'shape' => 'BooleanType', 'box' => true, ], 'NumberAttributeConstraints' => [ 'shape' => 'NumberAttributeConstraintsType', ], 'StringAttributeConstraints' => [ 'shape' => 'StringAttributeConstraintsType', ], ], ], 'SchemaAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'SchemaAttributeType', ], 'max' => 50, 'min' => 1, ], 'ScopeDoesNotExistException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ScopeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScopeType', ], 'max' => 50, ], 'ScopeType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\x21\\x23-\\x5B\\x5D-\\x7E]+', ], 'SearchPaginationTokenType' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\S]+', ], 'SearchedAttributeNamesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeNameType', ], ], 'SecretCodeType' => [ 'type' => 'string', 'min' => 16, 'pattern' => '[A-Za-z0-9]+', 'sensitive' => true, ], 'SecretHashType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w+=/]+', 'sensitive' => true, ], 'SessionType' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'sensitive' => true, ], 'SetRiskConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'CompromisedCredentialsRiskConfiguration' => [ 'shape' => 'CompromisedCredentialsRiskConfigurationType', ], 'AccountTakeoverRiskConfiguration' => [ 'shape' => 'AccountTakeoverRiskConfigurationType', ], 'RiskExceptionConfiguration' => [ 'shape' => 'RiskExceptionConfigurationType', ], ], ], 'SetRiskConfigurationResponse' => [ 'type' => 'structure', 'required' => [ 'RiskConfiguration', ], 'members' => [ 'RiskConfiguration' => [ 'shape' => 'RiskConfigurationType', ], ], ], 'SetUICustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'CSS' => [ 'shape' => 'CSSType', ], 'ImageFile' => [ 'shape' => 'ImageFileType', ], ], ], 'SetUICustomizationResponse' => [ 'type' => 'structure', 'required' => [ 'UICustomization', ], 'members' => [ 'UICustomization' => [ 'shape' => 'UICustomizationType', ], ], ], 'SetUserMFAPreferenceRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'SMSMfaSettings' => [ 'shape' => 'SMSMfaSettingsType', ], 'SoftwareTokenMfaSettings' => [ 'shape' => 'SoftwareTokenMfaSettingsType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'SetUserMFAPreferenceResponse' => [ 'type' => 'structure', 'members' => [], ], 'SetUserPoolMfaConfigRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'SmsMfaConfiguration' => [ 'shape' => 'SmsMfaConfigType', ], 'SoftwareTokenMfaConfiguration' => [ 'shape' => 'SoftwareTokenMfaConfigType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], ], ], 'SetUserPoolMfaConfigResponse' => [ 'type' => 'structure', 'members' => [ 'SmsMfaConfiguration' => [ 'shape' => 'SmsMfaConfigType', ], 'SoftwareTokenMfaConfiguration' => [ 'shape' => 'SoftwareTokenMfaConfigType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], ], ], 'SetUserSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'MFAOptions', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], ], ], 'SetUserSettingsResponse' => [ 'type' => 'structure', 'members' => [], ], 'SignUpRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', 'Password', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'Password' => [ 'shape' => 'PasswordType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'ValidationData' => [ 'shape' => 'AttributeListType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'SignUpResponse' => [ 'type' => 'structure', 'required' => [ 'UserConfirmed', 'UserSub', ], 'members' => [ 'UserConfirmed' => [ 'shape' => 'BooleanType', ], 'CodeDeliveryDetails' => [ 'shape' => 'CodeDeliveryDetailsType', ], 'UserSub' => [ 'shape' => 'StringType', ], ], ], 'SkippedIPRangeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringType', ], 'max' => 200, ], 'SmsConfigurationType' => [ 'type' => 'structure', 'required' => [ 'SnsCallerArn', ], 'members' => [ 'SnsCallerArn' => [ 'shape' => 'ArnType', ], 'ExternalId' => [ 'shape' => 'StringType', ], 'SnsRegion' => [ 'shape' => 'RegionCodeType', ], ], ], 'SmsMfaConfigType' => [ 'type' => 'structure', 'members' => [ 'SmsAuthenticationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'SmsConfiguration' => [ 'shape' => 'SmsConfigurationType', ], ], ], 'SmsVerificationMessageType' => [ 'type' => 'string', 'max' => 140, 'min' => 6, 'pattern' => '.*\\{####\\}.*', ], 'SoftwareTokenMFANotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'SoftwareTokenMFAUserCodeType' => [ 'type' => 'string', 'max' => 6, 'min' => 6, 'pattern' => '[0-9]+', 'sensitive' => true, ], 'SoftwareTokenMfaConfigType' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'BooleanType', ], ], ], 'SoftwareTokenMfaSettingsType' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'BooleanType', ], 'PreferredMfa' => [ 'shape' => 'BooleanType', ], ], ], 'StartUserImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'JobId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'JobId' => [ 'shape' => 'UserImportJobIdType', ], ], ], 'StartUserImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJob' => [ 'shape' => 'UserImportJobType', ], ], ], 'StatusType' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'StopUserImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'JobId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'JobId' => [ 'shape' => 'UserImportJobIdType', ], ], ], 'StopUserImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJob' => [ 'shape' => 'UserImportJobType', ], ], ], 'StringAttributeConstraintsType' => [ 'type' => 'structure', 'members' => [ 'MinLength' => [ 'shape' => 'StringType', ], 'MaxLength' => [ 'shape' => 'StringType', ], ], ], 'StringType' => [ 'type' => 'string', ], 'SupportedIdentityProvidersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProviderNameType', ], ], 'TagKeysType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ArnType', ], 'Tags' => [ 'shape' => 'UserPoolTagsType', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValueType' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TemporaryPasswordValidityDaysType' => [ 'type' => 'integer', 'max' => 365, 'min' => 0, ], 'TimeUnitsType' => [ 'type' => 'string', 'enum' => [ 'seconds', 'minutes', 'hours', 'days', ], ], 'TokenModelType' => [ 'type' => 'string', 'pattern' => '[A-Za-z0-9-_=.]+', 'sensitive' => true, ], 'TokenValidityUnitsType' => [ 'type' => 'structure', 'members' => [ 'AccessToken' => [ 'shape' => 'TimeUnitsType', ], 'IdToken' => [ 'shape' => 'TimeUnitsType', ], 'RefreshToken' => [ 'shape' => 'TimeUnitsType', ], ], ], 'TooManyFailedAttemptsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UICustomizationType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ImageUrl' => [ 'shape' => 'ImageUrlType', ], 'CSS' => [ 'shape' => 'CSSType', ], 'CSSVersion' => [ 'shape' => 'CSSVersionType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'UnauthorizedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnexpectedLambdaException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnsupportedIdentityProviderException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnsupportedOperationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnsupportedTokenTypeException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnsupportedUserStateException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ArnType', ], 'TagKeys' => [ 'shape' => 'UserPoolTagsListType', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAuthEventFeedbackRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'EventId', 'FeedbackToken', 'FeedbackValue', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'EventId' => [ 'shape' => 'EventIdType', ], 'FeedbackToken' => [ 'shape' => 'TokenModelType', ], 'FeedbackValue' => [ 'shape' => 'FeedbackValueType', ], ], ], 'UpdateAuthEventFeedbackResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateDeviceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'DeviceKey', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceRememberedStatus' => [ 'shape' => 'DeviceRememberedStatusType', ], ], ], 'UpdateDeviceStatusResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'UserPoolId', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Description' => [ 'shape' => 'DescriptionType', ], 'RoleArn' => [ 'shape' => 'ArnType', ], 'Precedence' => [ 'shape' => 'PrecedenceType', ], ], ], 'UpdateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'GroupType', ], ], ], 'UpdateIdentityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ProviderName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameType', ], 'ProviderDetails' => [ 'shape' => 'ProviderDetailsType', ], 'AttributeMapping' => [ 'shape' => 'AttributeMappingType', ], 'IdpIdentifiers' => [ 'shape' => 'IdpIdentifiersListType', ], ], ], 'UpdateIdentityProviderResponse' => [ 'type' => 'structure', 'required' => [ 'IdentityProvider', ], 'members' => [ 'IdentityProvider' => [ 'shape' => 'IdentityProviderType', ], ], ], 'UpdateResourceServerRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Identifier', 'Name', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], 'Name' => [ 'shape' => 'ResourceServerNameType', ], 'Scopes' => [ 'shape' => 'ResourceServerScopeListType', ], ], ], 'UpdateResourceServerResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceServer', ], 'members' => [ 'ResourceServer' => [ 'shape' => 'ResourceServerType', ], ], ], 'UpdateUserAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserAttributes', 'AccessToken', ], 'members' => [ 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'UpdateUserAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'CodeDeliveryDetailsList' => [ 'shape' => 'CodeDeliveryDetailsListType', ], ], ], 'UpdateUserPoolClientRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ClientName' => [ 'shape' => 'ClientNameType', ], 'RefreshTokenValidity' => [ 'shape' => 'RefreshTokenValidityType', ], 'AccessTokenValidity' => [ 'shape' => 'AccessTokenValidityType', ], 'IdTokenValidity' => [ 'shape' => 'IdTokenValidityType', ], 'TokenValidityUnits' => [ 'shape' => 'TokenValidityUnitsType', ], 'ReadAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'WriteAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'ExplicitAuthFlows' => [ 'shape' => 'ExplicitAuthFlowsListType', ], 'SupportedIdentityProviders' => [ 'shape' => 'SupportedIdentityProvidersListType', ], 'CallbackURLs' => [ 'shape' => 'CallbackURLsListType', ], 'LogoutURLs' => [ 'shape' => 'LogoutURLsListType', ], 'DefaultRedirectURI' => [ 'shape' => 'RedirectUrlType', ], 'AllowedOAuthFlows' => [ 'shape' => 'OAuthFlowsType', ], 'AllowedOAuthScopes' => [ 'shape' => 'ScopeListType', ], 'AllowedOAuthFlowsUserPoolClient' => [ 'shape' => 'BooleanType', ], 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfigurationType', ], 'PreventUserExistenceErrors' => [ 'shape' => 'PreventUserExistenceErrorTypes', ], 'EnableTokenRevocation' => [ 'shape' => 'WrappedBooleanType', ], 'EnablePropagateAdditionalUserContextData' => [ 'shape' => 'WrappedBooleanType', ], 'AuthSessionValidity' => [ 'shape' => 'AuthSessionValidityType', ], ], ], 'UpdateUserPoolClientResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolClient' => [ 'shape' => 'UserPoolClientType', ], ], ], 'UpdateUserPoolDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Domain', 'UserPoolId', 'CustomDomainConfig', ], 'members' => [ 'Domain' => [ 'shape' => 'DomainType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CustomDomainConfig' => [ 'shape' => 'CustomDomainConfigType', ], ], ], 'UpdateUserPoolDomainResponse' => [ 'type' => 'structure', 'members' => [ 'CloudFrontDomain' => [ 'shape' => 'DomainType', ], ], ], 'UpdateUserPoolRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Policies' => [ 'shape' => 'UserPoolPolicyType', ], 'DeletionProtection' => [ 'shape' => 'DeletionProtectionType', ], 'LambdaConfig' => [ 'shape' => 'LambdaConfigType', ], 'AutoVerifiedAttributes' => [ 'shape' => 'VerifiedAttributesListType', ], 'SmsVerificationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailVerificationMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailVerificationSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], 'VerificationMessageTemplate' => [ 'shape' => 'VerificationMessageTemplateType', ], 'SmsAuthenticationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'UserAttributeUpdateSettings' => [ 'shape' => 'UserAttributeUpdateSettingsType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], 'DeviceConfiguration' => [ 'shape' => 'DeviceConfigurationType', ], 'EmailConfiguration' => [ 'shape' => 'EmailConfigurationType', ], 'SmsConfiguration' => [ 'shape' => 'SmsConfigurationType', ], 'UserPoolTags' => [ 'shape' => 'UserPoolTagsType', ], 'AdminCreateUserConfig' => [ 'shape' => 'AdminCreateUserConfigType', ], 'UserPoolAddOns' => [ 'shape' => 'UserPoolAddOnsType', ], 'AccountRecoverySetting' => [ 'shape' => 'AccountRecoverySettingType', ], ], ], 'UpdateUserPoolResponse' => [ 'type' => 'structure', 'members' => [], ], 'UserAttributeUpdateSettingsType' => [ 'type' => 'structure', 'members' => [ 'AttributesRequireVerificationBeforeUpdate' => [ 'shape' => 'AttributesRequireVerificationBeforeUpdateType', ], ], ], 'UserContextDataType' => [ 'type' => 'structure', 'members' => [ 'IpAddress' => [ 'shape' => 'StringType', ], 'EncodedData' => [ 'shape' => 'StringType', ], ], 'sensitive' => true, ], 'UserFilterType' => [ 'type' => 'string', 'max' => 256, ], 'UserImportInProgressException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserImportJobIdType' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => 'import-[0-9a-zA-Z-]+', ], 'UserImportJobNameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w\\s+=,.@-]+', ], 'UserImportJobStatusType' => [ 'type' => 'string', 'enum' => [ 'Created', 'Pending', 'InProgress', 'Stopping', 'Expired', 'Stopped', 'Failed', 'Succeeded', ], ], 'UserImportJobType' => [ 'type' => 'structure', 'members' => [ 'JobName' => [ 'shape' => 'UserImportJobNameType', ], 'JobId' => [ 'shape' => 'UserImportJobIdType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'PreSignedUrl' => [ 'shape' => 'PreSignedUrlType', ], 'CreationDate' => [ 'shape' => 'DateType', ], 'StartDate' => [ 'shape' => 'DateType', ], 'CompletionDate' => [ 'shape' => 'DateType', ], 'Status' => [ 'shape' => 'UserImportJobStatusType', ], 'CloudWatchLogsRoleArn' => [ 'shape' => 'ArnType', ], 'ImportedUsers' => [ 'shape' => 'LongType', ], 'SkippedUsers' => [ 'shape' => 'LongType', ], 'FailedUsers' => [ 'shape' => 'LongType', ], 'CompletionMessage' => [ 'shape' => 'CompletionMessageType', ], ], ], 'UserImportJobsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserImportJobType', ], 'max' => 50, 'min' => 1, ], 'UserLambdaValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserMFASettingListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringType', ], ], 'UserNotConfirmedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserPoolAddOnNotEnabledException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserPoolAddOnsType' => [ 'type' => 'structure', 'required' => [ 'AdvancedSecurityMode', ], 'members' => [ 'AdvancedSecurityMode' => [ 'shape' => 'AdvancedSecurityModeType', ], ], ], 'UserPoolClientDescription' => [ 'type' => 'structure', 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientName' => [ 'shape' => 'ClientNameType', ], ], ], 'UserPoolClientListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserPoolClientDescription', ], ], 'UserPoolClientType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientName' => [ 'shape' => 'ClientNameType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ClientSecret' => [ 'shape' => 'ClientSecretType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], 'RefreshTokenValidity' => [ 'shape' => 'RefreshTokenValidityType', ], 'AccessTokenValidity' => [ 'shape' => 'AccessTokenValidityType', ], 'IdTokenValidity' => [ 'shape' => 'IdTokenValidityType', ], 'TokenValidityUnits' => [ 'shape' => 'TokenValidityUnitsType', ], 'ReadAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'WriteAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'ExplicitAuthFlows' => [ 'shape' => 'ExplicitAuthFlowsListType', ], 'SupportedIdentityProviders' => [ 'shape' => 'SupportedIdentityProvidersListType', ], 'CallbackURLs' => [ 'shape' => 'CallbackURLsListType', ], 'LogoutURLs' => [ 'shape' => 'LogoutURLsListType', ], 'DefaultRedirectURI' => [ 'shape' => 'RedirectUrlType', ], 'AllowedOAuthFlows' => [ 'shape' => 'OAuthFlowsType', ], 'AllowedOAuthScopes' => [ 'shape' => 'ScopeListType', ], 'AllowedOAuthFlowsUserPoolClient' => [ 'shape' => 'BooleanType', 'box' => true, ], 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfigurationType', ], 'PreventUserExistenceErrors' => [ 'shape' => 'PreventUserExistenceErrorTypes', ], 'EnableTokenRevocation' => [ 'shape' => 'WrappedBooleanType', ], 'EnablePropagateAdditionalUserContextData' => [ 'shape' => 'WrappedBooleanType', ], 'AuthSessionValidity' => [ 'shape' => 'AuthSessionValidityType', ], ], ], 'UserPoolDescriptionType' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserPoolIdType', ], 'Name' => [ 'shape' => 'UserPoolNameType', ], 'LambdaConfig' => [ 'shape' => 'LambdaConfigType', ], 'Status' => [ 'shape' => 'StatusType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'UserPoolIdType' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'UserPoolListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserPoolDescriptionType', ], ], 'UserPoolMfaType' => [ 'type' => 'string', 'enum' => [ 'OFF', 'ON', 'OPTIONAL', ], ], 'UserPoolNameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w\\s+=,.@-]+', ], 'UserPoolPolicyType' => [ 'type' => 'structure', 'members' => [ 'PasswordPolicy' => [ 'shape' => 'PasswordPolicyType', ], ], ], 'UserPoolTaggingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserPoolTagsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKeysType', ], ], 'UserPoolTagsType' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKeysType', ], 'value' => [ 'shape' => 'TagValueType', ], ], 'UserPoolType' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserPoolIdType', ], 'Name' => [ 'shape' => 'UserPoolNameType', ], 'Policies' => [ 'shape' => 'UserPoolPolicyType', ], 'DeletionProtection' => [ 'shape' => 'DeletionProtectionType', ], 'LambdaConfig' => [ 'shape' => 'LambdaConfigType', ], 'Status' => [ 'shape' => 'StatusType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], 'SchemaAttributes' => [ 'shape' => 'SchemaAttributesListType', ], 'AutoVerifiedAttributes' => [ 'shape' => 'VerifiedAttributesListType', ], 'AliasAttributes' => [ 'shape' => 'AliasAttributesListType', ], 'UsernameAttributes' => [ 'shape' => 'UsernameAttributesListType', ], 'SmsVerificationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailVerificationMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailVerificationSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], 'VerificationMessageTemplate' => [ 'shape' => 'VerificationMessageTemplateType', ], 'SmsAuthenticationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'UserAttributeUpdateSettings' => [ 'shape' => 'UserAttributeUpdateSettingsType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], 'DeviceConfiguration' => [ 'shape' => 'DeviceConfigurationType', ], 'EstimatedNumberOfUsers' => [ 'shape' => 'IntegerType', ], 'EmailConfiguration' => [ 'shape' => 'EmailConfigurationType', ], 'SmsConfiguration' => [ 'shape' => 'SmsConfigurationType', ], 'UserPoolTags' => [ 'shape' => 'UserPoolTagsType', ], 'SmsConfigurationFailure' => [ 'shape' => 'StringType', ], 'EmailConfigurationFailure' => [ 'shape' => 'StringType', ], 'Domain' => [ 'shape' => 'DomainType', ], 'CustomDomain' => [ 'shape' => 'DomainType', ], 'AdminCreateUserConfig' => [ 'shape' => 'AdminCreateUserConfigType', ], 'UserPoolAddOns' => [ 'shape' => 'UserPoolAddOnsType', ], 'UsernameConfiguration' => [ 'shape' => 'UsernameConfigurationType', ], 'Arn' => [ 'shape' => 'ArnType', ], 'AccountRecoverySetting' => [ 'shape' => 'AccountRecoverySettingType', ], ], ], 'UserStatusType' => [ 'type' => 'string', 'enum' => [ 'UNCONFIRMED', 'CONFIRMED', 'ARCHIVED', 'COMPROMISED', 'UNKNOWN', 'RESET_REQUIRED', 'FORCE_CHANGE_PASSWORD', ], ], 'UserType' => [ 'type' => 'structure', 'members' => [ 'Username' => [ 'shape' => 'UsernameType', ], 'Attributes' => [ 'shape' => 'AttributeListType', ], 'UserCreateDate' => [ 'shape' => 'DateType', ], 'UserLastModifiedDate' => [ 'shape' => 'DateType', ], 'Enabled' => [ 'shape' => 'BooleanType', ], 'UserStatus' => [ 'shape' => 'UserStatusType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], ], ], 'UsernameAttributeType' => [ 'type' => 'string', 'enum' => [ 'phone_number', 'email', ], ], 'UsernameAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UsernameAttributeType', ], ], 'UsernameConfigurationType' => [ 'type' => 'structure', 'required' => [ 'CaseSensitive', ], 'members' => [ 'CaseSensitive' => [ 'shape' => 'WrappedBooleanType', ], ], ], 'UsernameExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UsernameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', 'sensitive' => true, ], 'UsersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserType', ], ], 'VerificationMessageTemplateType' => [ 'type' => 'structure', 'members' => [ 'SmsMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], 'EmailMessageByLink' => [ 'shape' => 'EmailVerificationMessageByLinkType', ], 'EmailSubjectByLink' => [ 'shape' => 'EmailVerificationSubjectByLinkType', ], 'DefaultEmailOption' => [ 'shape' => 'DefaultEmailOptionType', ], ], ], 'VerifiedAttributeType' => [ 'type' => 'string', 'enum' => [ 'phone_number', 'email', ], ], 'VerifiedAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedAttributeType', ], ], 'VerifySoftwareTokenRequest' => [ 'type' => 'structure', 'required' => [ 'UserCode', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'Session' => [ 'shape' => 'SessionType', ], 'UserCode' => [ 'shape' => 'SoftwareTokenMFAUserCodeType', ], 'FriendlyDeviceName' => [ 'shape' => 'StringType', ], ], ], 'VerifySoftwareTokenResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'VerifySoftwareTokenResponseType', ], 'Session' => [ 'shape' => 'SessionType', ], ], ], 'VerifySoftwareTokenResponseType' => [ 'type' => 'string', 'enum' => [ 'SUCCESS', 'ERROR', ], ], 'VerifyUserAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'AttributeName', 'Code', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'AttributeName' => [ 'shape' => 'AttributeNameType', ], 'Code' => [ 'shape' => 'ConfirmationCodeType', ], ], ], 'VerifyUserAttributeResponse' => [ 'type' => 'structure', 'members' => [], ], 'WrappedBooleanType' => [ 'type' => 'boolean', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2016-04-18', 'endpointPrefix' => 'cognito-idp', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon Cognito Identity Provider', 'serviceId' => 'Cognito Identity Provider', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSCognitoIdentityProviderService', 'uid' => 'cognito-idp-2016-04-18', ], 'operations' => [ 'AddCustomAttributes' => [ 'name' => 'AddCustomAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddCustomAttributesRequest', ], 'output' => [ 'shape' => 'AddCustomAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserImportInProgressException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminAddUserToGroup' => [ 'name' => 'AdminAddUserToGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminAddUserToGroupRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminConfirmSignUp' => [ 'name' => 'AdminConfirmSignUp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminConfirmSignUpRequest', ], 'output' => [ 'shape' => 'AdminConfirmSignUpResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyFailedAttemptsException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminCreateUser' => [ 'name' => 'AdminCreateUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminCreateUserRequest', ], 'output' => [ 'shape' => 'AdminCreateUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UsernameExistsException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UnsupportedUserStateException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminDeleteUser' => [ 'name' => 'AdminDeleteUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminDeleteUserRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminDeleteUserAttributes' => [ 'name' => 'AdminDeleteUserAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminDeleteUserAttributesRequest', ], 'output' => [ 'shape' => 'AdminDeleteUserAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminDisableProviderForUser' => [ 'name' => 'AdminDisableProviderForUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminDisableProviderForUserRequest', ], 'output' => [ 'shape' => 'AdminDisableProviderForUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminDisableUser' => [ 'name' => 'AdminDisableUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminDisableUserRequest', ], 'output' => [ 'shape' => 'AdminDisableUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminEnableUser' => [ 'name' => 'AdminEnableUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminEnableUserRequest', ], 'output' => [ 'shape' => 'AdminEnableUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminForgetDevice' => [ 'name' => 'AdminForgetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminForgetDeviceRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminGetDevice' => [ 'name' => 'AdminGetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminGetDeviceRequest', ], 'output' => [ 'shape' => 'AdminGetDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'NotAuthorizedException', ], ], ], 'AdminGetUser' => [ 'name' => 'AdminGetUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminGetUserRequest', ], 'output' => [ 'shape' => 'AdminGetUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminInitiateAuth' => [ 'name' => 'AdminInitiateAuth', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminInitiateAuthRequest', ], 'output' => [ 'shape' => 'AdminInitiateAuthResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'MFAMethodNotFoundException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], ], ], 'AdminLinkProviderForUser' => [ 'name' => 'AdminLinkProviderForUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminLinkProviderForUserRequest', ], 'output' => [ 'shape' => 'AdminLinkProviderForUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminListDevices' => [ 'name' => 'AdminListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminListDevicesRequest', ], 'output' => [ 'shape' => 'AdminListDevicesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'NotAuthorizedException', ], ], ], 'AdminListGroupsForUser' => [ 'name' => 'AdminListGroupsForUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminListGroupsForUserRequest', ], 'output' => [ 'shape' => 'AdminListGroupsForUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminListUserAuthEvents' => [ 'name' => 'AdminListUserAuthEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminListUserAuthEventsRequest', ], 'output' => [ 'shape' => 'AdminListUserAuthEventsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminRemoveUserFromGroup' => [ 'name' => 'AdminRemoveUserFromGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminRemoveUserFromGroupRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminResetUserPassword' => [ 'name' => 'AdminResetUserPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminResetUserPasswordRequest', ], 'output' => [ 'shape' => 'AdminResetUserPasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminRespondToAuthChallenge' => [ 'name' => 'AdminRespondToAuthChallenge', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminRespondToAuthChallengeRequest', ], 'output' => [ 'shape' => 'AdminRespondToAuthChallengeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'MFAMethodNotFoundException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'SoftwareTokenMFANotFoundException', ], ], ], 'AdminSetUserMFAPreference' => [ 'name' => 'AdminSetUserMFAPreference', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminSetUserMFAPreferenceRequest', ], 'output' => [ 'shape' => 'AdminSetUserMFAPreferenceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminSetUserPassword' => [ 'name' => 'AdminSetUserPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminSetUserPasswordRequest', ], 'output' => [ 'shape' => 'AdminSetUserPasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], ], ], 'AdminSetUserSettings' => [ 'name' => 'AdminSetUserSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminSetUserSettingsRequest', ], 'output' => [ 'shape' => 'AdminSetUserSettingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminUpdateAuthEventFeedback' => [ 'name' => 'AdminUpdateAuthEventFeedback', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminUpdateAuthEventFeedbackRequest', ], 'output' => [ 'shape' => 'AdminUpdateAuthEventFeedbackResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminUpdateDeviceStatus' => [ 'name' => 'AdminUpdateDeviceStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminUpdateDeviceStatusRequest', ], 'output' => [ 'shape' => 'AdminUpdateDeviceStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AdminUpdateUserAttributes' => [ 'name' => 'AdminUpdateUserAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminUpdateUserAttributesRequest', ], 'output' => [ 'shape' => 'AdminUpdateUserAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], ], ], 'AdminUserGlobalSignOut' => [ 'name' => 'AdminUserGlobalSignOut', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AdminUserGlobalSignOutRequest', ], 'output' => [ 'shape' => 'AdminUserGlobalSignOutResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'AssociateSoftwareToken' => [ 'name' => 'AssociateSoftwareToken', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateSoftwareTokenRequest', ], 'output' => [ 'shape' => 'AssociateSoftwareTokenResponse', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'SoftwareTokenMFANotFoundException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'ChangePassword' => [ 'name' => 'ChangePassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ChangePasswordRequest', ], 'output' => [ 'shape' => 'ChangePasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'ConfirmDevice' => [ 'name' => 'ConfirmDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmDeviceRequest', ], 'output' => [ 'shape' => 'ConfirmDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'UsernameExistsException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'ConfirmForgotPassword' => [ 'name' => 'ConfirmForgotPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmForgotPasswordRequest', ], 'output' => [ 'shape' => 'ConfirmForgotPasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'TooManyFailedAttemptsException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'ConfirmSignUp' => [ 'name' => 'ConfirmSignUp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmSignUpRequest', ], 'output' => [ 'shape' => 'ConfirmSignUpResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyFailedAttemptsException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'CreateGroup' => [ 'name' => 'CreateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGroupRequest', ], 'output' => [ 'shape' => 'CreateGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'GroupExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateIdentityProvider' => [ 'name' => 'CreateIdentityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateIdentityProviderRequest', ], 'output' => [ 'shape' => 'CreateIdentityProviderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateProviderException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateResourceServer' => [ 'name' => 'CreateResourceServer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResourceServerRequest', ], 'output' => [ 'shape' => 'CreateResourceServerResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateUserImportJob' => [ 'name' => 'CreateUserImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserImportJobRequest', ], 'output' => [ 'shape' => 'CreateUserImportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateUserPool' => [ 'name' => 'CreateUserPool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserPoolRequest', ], 'output' => [ 'shape' => 'CreateUserPoolResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserPoolTaggingException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateUserPoolClient' => [ 'name' => 'CreateUserPoolClient', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserPoolClientRequest', ], 'output' => [ 'shape' => 'CreateUserPoolClientResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ScopeDoesNotExistException', ], [ 'shape' => 'InvalidOAuthFlowException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'CreateUserPoolDomain' => [ 'name' => 'CreateUserPoolDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserPoolDomainRequest', ], 'output' => [ 'shape' => 'CreateUserPoolDomainResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteIdentityProvider' => [ 'name' => 'DeleteIdentityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteIdentityProviderRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnsupportedIdentityProviderException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteResourceServer' => [ 'name' => 'DeleteResourceServer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResourceServerRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'DeleteUserAttributes' => [ 'name' => 'DeleteUserAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserAttributesRequest', ], 'output' => [ 'shape' => 'DeleteUserAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'DeleteUserPool' => [ 'name' => 'DeleteUserPool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserPoolRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserImportInProgressException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteUserPoolClient' => [ 'name' => 'DeleteUserPoolClient', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserPoolClientRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteUserPoolDomain' => [ 'name' => 'DeleteUserPoolDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserPoolDomainRequest', ], 'output' => [ 'shape' => 'DeleteUserPoolDomainResponse', ], 'errors' => [ [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeIdentityProvider' => [ 'name' => 'DescribeIdentityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeIdentityProviderRequest', ], 'output' => [ 'shape' => 'DescribeIdentityProviderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeResourceServer' => [ 'name' => 'DescribeResourceServer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeResourceServerRequest', ], 'output' => [ 'shape' => 'DescribeResourceServerResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeRiskConfiguration' => [ 'name' => 'DescribeRiskConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRiskConfigurationRequest', ], 'output' => [ 'shape' => 'DescribeRiskConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeUserImportJob' => [ 'name' => 'DescribeUserImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserImportJobRequest', ], 'output' => [ 'shape' => 'DescribeUserImportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeUserPool' => [ 'name' => 'DescribeUserPool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserPoolRequest', ], 'output' => [ 'shape' => 'DescribeUserPoolResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserPoolTaggingException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeUserPoolClient' => [ 'name' => 'DescribeUserPoolClient', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserPoolClientRequest', ], 'output' => [ 'shape' => 'DescribeUserPoolClientResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DescribeUserPoolDomain' => [ 'name' => 'DescribeUserPoolDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserPoolDomainRequest', ], 'output' => [ 'shape' => 'DescribeUserPoolDomainResponse', ], 'errors' => [ [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ForgetDevice' => [ 'name' => 'ForgetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ForgetDeviceRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'ForgotPassword' => [ 'name' => 'ForgotPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ForgotPasswordRequest', ], 'output' => [ 'shape' => 'ForgotPasswordResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'GetCSVHeader' => [ 'name' => 'GetCSVHeader', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCSVHeaderRequest', ], 'output' => [ 'shape' => 'GetCSVHeaderResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetDevice' => [ 'name' => 'GetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceRequest', ], 'output' => [ 'shape' => 'GetDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'GetGroup' => [ 'name' => 'GetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetGroupRequest', ], 'output' => [ 'shape' => 'GetGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetIdentityProviderByIdentifier' => [ 'name' => 'GetIdentityProviderByIdentifier', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetIdentityProviderByIdentifierRequest', ], 'output' => [ 'shape' => 'GetIdentityProviderByIdentifierResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetLogDeliveryConfiguration' => [ 'name' => 'GetLogDeliveryConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLogDeliveryConfigurationRequest', ], 'output' => [ 'shape' => 'GetLogDeliveryConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetSigningCertificate' => [ 'name' => 'GetSigningCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSigningCertificateRequest', ], 'output' => [ 'shape' => 'GetSigningCertificateResponse', ], 'errors' => [ [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetUICustomization' => [ 'name' => 'GetUICustomization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUICustomizationRequest', ], 'output' => [ 'shape' => 'GetUICustomizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetUser' => [ 'name' => 'GetUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUserRequest', ], 'output' => [ 'shape' => 'GetUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'GetUserAttributeVerificationCode' => [ 'name' => 'GetUserAttributeVerificationCode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUserAttributeVerificationCodeRequest', ], 'output' => [ 'shape' => 'GetUserAttributeVerificationCodeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'GetUserPoolMfaConfig' => [ 'name' => 'GetUserPoolMfaConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUserPoolMfaConfigRequest', ], 'output' => [ 'shape' => 'GetUserPoolMfaConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GlobalSignOut' => [ 'name' => 'GlobalSignOut', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GlobalSignOutRequest', ], 'output' => [ 'shape' => 'GlobalSignOutResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'InitiateAuth' => [ 'name' => 'InitiateAuth', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'InitiateAuthRequest', ], 'output' => [ 'shape' => 'InitiateAuthResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListIdentityProviders' => [ 'name' => 'ListIdentityProviders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListIdentityProvidersRequest', ], 'output' => [ 'shape' => 'ListIdentityProvidersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListResourceServers' => [ 'name' => 'ListResourceServers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceServersRequest', ], 'output' => [ 'shape' => 'ListResourceServersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUserImportJobs' => [ 'name' => 'ListUserImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserImportJobsRequest', ], 'output' => [ 'shape' => 'ListUserImportJobsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUserPoolClients' => [ 'name' => 'ListUserPoolClients', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserPoolClientsRequest', ], 'output' => [ 'shape' => 'ListUserPoolClientsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUserPools' => [ 'name' => 'ListUserPools', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserPoolsRequest', ], 'output' => [ 'shape' => 'ListUserPoolsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUsers' => [ 'name' => 'ListUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUsersRequest', ], 'output' => [ 'shape' => 'ListUsersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListUsersInGroup' => [ 'name' => 'ListUsersInGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUsersInGroupRequest', ], 'output' => [ 'shape' => 'ListUsersInGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ResendConfirmationCode' => [ 'name' => 'ResendConfirmationCode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResendConfirmationCodeRequest', ], 'output' => [ 'shape' => 'ResendConfirmationCodeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'RespondToAuthChallenge' => [ 'name' => 'RespondToAuthChallenge', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RespondToAuthChallengeRequest', ], 'output' => [ 'shape' => 'RespondToAuthChallengeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'MFAMethodNotFoundException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'SoftwareTokenMFANotFoundException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'RevokeToken' => [ 'name' => 'RevokeToken', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeTokenRequest', ], 'output' => [ 'shape' => 'RevokeTokenResponse', ], 'errors' => [ [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnsupportedOperationException', ], [ 'shape' => 'UnsupportedTokenTypeException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'SetLogDeliveryConfiguration' => [ 'name' => 'SetLogDeliveryConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetLogDeliveryConfigurationRequest', ], 'output' => [ 'shape' => 'SetLogDeliveryConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'SetRiskConfiguration' => [ 'name' => 'SetRiskConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetRiskConfigurationRequest', ], 'output' => [ 'shape' => 'SetRiskConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'SetUICustomization' => [ 'name' => 'SetUICustomization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUICustomizationRequest', ], 'output' => [ 'shape' => 'SetUICustomizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'SetUserMFAPreference' => [ 'name' => 'SetUserMFAPreference', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUserMFAPreferenceRequest', ], 'output' => [ 'shape' => 'SetUserMFAPreferenceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'SetUserPoolMfaConfig' => [ 'name' => 'SetUserPoolMfaConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUserPoolMfaConfigRequest', ], 'output' => [ 'shape' => 'SetUserPoolMfaConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'SetUserSettings' => [ 'name' => 'SetUserSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUserSettingsRequest', ], 'output' => [ 'shape' => 'SetUserSettingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'SignUp' => [ 'name' => 'SignUp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SignUpRequest', ], 'output' => [ 'shape' => 'SignUpResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'UsernameExistsException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'StartUserImportJob' => [ 'name' => 'StartUserImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartUserImportJobRequest', ], 'output' => [ 'shape' => 'StartUserImportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'NotAuthorizedException', ], ], ], 'StopUserImportJob' => [ 'name' => 'StopUserImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopUserImportJobRequest', ], 'output' => [ 'shape' => 'StopUserImportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'NotAuthorizedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateAuthEventFeedback' => [ 'name' => 'UpdateAuthEventFeedback', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAuthEventFeedbackRequest', ], 'output' => [ 'shape' => 'UpdateAuthEventFeedbackResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserPoolAddOnNotEnabledException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateDeviceStatus' => [ 'name' => 'UpdateDeviceStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceStatusRequest', ], 'output' => [ 'shape' => 'UpdateDeviceStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'UpdateGroup' => [ 'name' => 'UpdateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateGroupRequest', ], 'output' => [ 'shape' => 'UpdateGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateIdentityProvider' => [ 'name' => 'UpdateIdentityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateIdentityProviderRequest', ], 'output' => [ 'shape' => 'UpdateIdentityProviderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnsupportedIdentityProviderException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateResourceServer' => [ 'name' => 'UpdateResourceServer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResourceServerRequest', ], 'output' => [ 'shape' => 'UpdateResourceServerResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateUserAttributes' => [ 'name' => 'UpdateUserAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserAttributesRequest', ], 'output' => [ 'shape' => 'UpdateUserAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UnexpectedLambdaException', ], [ 'shape' => 'UserLambdaValidationException', ], [ 'shape' => 'InvalidLambdaResponseException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], [ 'shape' => 'CodeDeliveryFailureException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], 'UpdateUserPool' => [ 'name' => 'UpdateUserPool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserPoolRequest', ], 'output' => [ 'shape' => 'UpdateUserPoolResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'UserImportInProgressException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidSmsRoleAccessPolicyException', ], [ 'shape' => 'InvalidSmsRoleTrustRelationshipException', ], [ 'shape' => 'UserPoolTaggingException', ], [ 'shape' => 'InvalidEmailRoleAccessPolicyException', ], ], ], 'UpdateUserPoolClient' => [ 'name' => 'UpdateUserPoolClient', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserPoolClientRequest', ], 'output' => [ 'shape' => 'UpdateUserPoolClientResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ScopeDoesNotExistException', ], [ 'shape' => 'InvalidOAuthFlowException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'UpdateUserPoolDomain' => [ 'name' => 'UpdateUserPoolDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserPoolDomainRequest', ], 'output' => [ 'shape' => 'UpdateUserPoolDomainResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'VerifySoftwareToken' => [ 'name' => 'VerifySoftwareToken', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'VerifySoftwareTokenRequest', ], 'output' => [ 'shape' => 'VerifySoftwareTokenResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidUserPoolConfigurationException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'EnableSoftwareTokenMFAException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'SoftwareTokenMFANotFoundException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'VerifyUserAttribute' => [ 'name' => 'VerifyUserAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'VerifyUserAttributeRequest', ], 'output' => [ 'shape' => 'VerifyUserAttributeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'CodeMismatchException', ], [ 'shape' => 'ExpiredCodeException', ], [ 'shape' => 'NotAuthorizedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PasswordResetRequiredException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'UserNotConfirmedException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'AliasExistsException', ], [ 'shape' => 'ForbiddenException', ], ], 'authtype' => 'none', ], ], 'shapes' => [ 'AWSAccountIdType' => [ 'type' => 'string', 'max' => 12, 'pattern' => '[0-9]+', ], 'AccessTokenValidityType' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'AccountRecoverySettingType' => [ 'type' => 'structure', 'members' => [ 'RecoveryMechanisms' => [ 'shape' => 'RecoveryMechanismsType', ], ], ], 'AccountTakeoverActionNotifyType' => [ 'type' => 'boolean', ], 'AccountTakeoverActionType' => [ 'type' => 'structure', 'required' => [ 'Notify', 'EventAction', ], 'members' => [ 'Notify' => [ 'shape' => 'AccountTakeoverActionNotifyType', ], 'EventAction' => [ 'shape' => 'AccountTakeoverEventActionType', ], ], ], 'AccountTakeoverActionsType' => [ 'type' => 'structure', 'members' => [ 'LowAction' => [ 'shape' => 'AccountTakeoverActionType', ], 'MediumAction' => [ 'shape' => 'AccountTakeoverActionType', ], 'HighAction' => [ 'shape' => 'AccountTakeoverActionType', ], ], ], 'AccountTakeoverEventActionType' => [ 'type' => 'string', 'enum' => [ 'BLOCK', 'MFA_IF_CONFIGURED', 'MFA_REQUIRED', 'NO_ACTION', ], ], 'AccountTakeoverRiskConfigurationType' => [ 'type' => 'structure', 'required' => [ 'Actions', ], 'members' => [ 'NotifyConfiguration' => [ 'shape' => 'NotifyConfigurationType', ], 'Actions' => [ 'shape' => 'AccountTakeoverActionsType', ], ], ], 'AddCustomAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'CustomAttributes', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CustomAttributes' => [ 'shape' => 'CustomAttributesListType', ], ], ], 'AddCustomAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminAddUserToGroupRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'GroupName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'GroupName' => [ 'shape' => 'GroupNameType', ], ], ], 'AdminConfirmSignUpRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminConfirmSignUpResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminCreateUserConfigType' => [ 'type' => 'structure', 'members' => [ 'AllowAdminCreateUserOnly' => [ 'shape' => 'BooleanType', ], 'UnusedAccountValidityDays' => [ 'shape' => 'AdminCreateUserUnusedAccountValidityDaysType', ], 'InviteMessageTemplate' => [ 'shape' => 'MessageTemplateType', ], ], ], 'AdminCreateUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'ValidationData' => [ 'shape' => 'AttributeListType', ], 'TemporaryPassword' => [ 'shape' => 'PasswordType', ], 'ForceAliasCreation' => [ 'shape' => 'ForceAliasCreation', ], 'MessageAction' => [ 'shape' => 'MessageActionType', ], 'DesiredDeliveryMediums' => [ 'shape' => 'DeliveryMediumListType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminCreateUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'UserType', ], ], ], 'AdminCreateUserUnusedAccountValidityDaysType' => [ 'type' => 'integer', 'max' => 365, 'min' => 0, ], 'AdminDeleteUserAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'UserAttributeNames', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributeNames' => [ 'shape' => 'AttributeNameListType', ], ], ], 'AdminDeleteUserAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminDeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminDisableProviderForUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'User', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'StringType', ], 'User' => [ 'shape' => 'ProviderUserIdentifierType', ], ], ], 'AdminDisableProviderForUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminDisableUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminDisableUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminEnableUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminEnableUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminForgetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'DeviceKey', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], ], ], 'AdminGetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceKey', 'UserPoolId', 'Username', ], 'members' => [ 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminGetDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'Device', ], 'members' => [ 'Device' => [ 'shape' => 'DeviceType', ], ], ], 'AdminGetUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminGetUserResponse' => [ 'type' => 'structure', 'required' => [ 'Username', ], 'members' => [ 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'UserCreateDate' => [ 'shape' => 'DateType', ], 'UserLastModifiedDate' => [ 'shape' => 'DateType', ], 'Enabled' => [ 'shape' => 'BooleanType', ], 'UserStatus' => [ 'shape' => 'UserStatusType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], 'PreferredMfaSetting' => [ 'shape' => 'StringType', ], 'UserMFASettingList' => [ 'shape' => 'UserMFASettingListType', ], ], ], 'AdminInitiateAuthRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', 'AuthFlow', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'AuthFlow' => [ 'shape' => 'AuthFlowType', ], 'AuthParameters' => [ 'shape' => 'AuthParametersType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'ContextData' => [ 'shape' => 'ContextDataType', ], ], ], 'AdminInitiateAuthResponse' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeParameters' => [ 'shape' => 'ChallengeParametersType', ], 'AuthenticationResult' => [ 'shape' => 'AuthenticationResultType', ], ], ], 'AdminLinkProviderForUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'DestinationUser', 'SourceUser', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'StringType', ], 'DestinationUser' => [ 'shape' => 'ProviderUserIdentifierType', ], 'SourceUser' => [ 'shape' => 'ProviderUserIdentifierType', ], ], ], 'AdminLinkProviderForUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminListDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'AdminListDevicesResponse' => [ 'type' => 'structure', 'members' => [ 'Devices' => [ 'shape' => 'DeviceListType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'AdminListGroupsForUserRequest' => [ 'type' => 'structure', 'required' => [ 'Username', 'UserPoolId', ], 'members' => [ 'Username' => [ 'shape' => 'UsernameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'AdminListGroupsForUserResponse' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'GroupListType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'AdminListUserAuthEventsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'MaxResults' => [ 'shape' => 'QueryLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'AdminListUserAuthEventsResponse' => [ 'type' => 'structure', 'members' => [ 'AuthEvents' => [ 'shape' => 'AuthEventsType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'AdminRemoveUserFromGroupRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'GroupName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'GroupName' => [ 'shape' => 'GroupNameType', ], ], ], 'AdminResetUserPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminResetUserPasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminRespondToAuthChallengeRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', 'ChallengeName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'ChallengeResponses' => [ 'shape' => 'ChallengeResponsesType', ], 'Session' => [ 'shape' => 'SessionType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'ContextData' => [ 'shape' => 'ContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminRespondToAuthChallengeResponse' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeParameters' => [ 'shape' => 'ChallengeParametersType', ], 'AuthenticationResult' => [ 'shape' => 'AuthenticationResultType', ], ], ], 'AdminSetUserMFAPreferenceRequest' => [ 'type' => 'structure', 'required' => [ 'Username', 'UserPoolId', ], 'members' => [ 'SMSMfaSettings' => [ 'shape' => 'SMSMfaSettingsType', ], 'SoftwareTokenMfaSettings' => [ 'shape' => 'SoftwareTokenMfaSettingsType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'AdminSetUserMFAPreferenceResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminSetUserPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'Password', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'Password' => [ 'shape' => 'PasswordType', ], 'Permanent' => [ 'shape' => 'BooleanType', ], ], ], 'AdminSetUserPasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminSetUserSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'MFAOptions', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], ], ], 'AdminSetUserSettingsResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminUpdateAuthEventFeedbackRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'EventId', 'FeedbackValue', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'EventId' => [ 'shape' => 'EventIdType', ], 'FeedbackValue' => [ 'shape' => 'FeedbackValueType', ], ], ], 'AdminUpdateAuthEventFeedbackResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminUpdateDeviceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'DeviceKey', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceRememberedStatus' => [ 'shape' => 'DeviceRememberedStatusType', ], ], ], 'AdminUpdateDeviceStatusResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminUpdateUserAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'UserAttributes', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'AdminUpdateUserAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdminUserGlobalSignOutRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], ], ], 'AdminUserGlobalSignOutResponse' => [ 'type' => 'structure', 'members' => [], ], 'AdvancedSecurityModeType' => [ 'type' => 'string', 'enum' => [ 'OFF', 'AUDIT', 'ENFORCED', ], ], 'AliasAttributeType' => [ 'type' => 'string', 'enum' => [ 'phone_number', 'email', 'preferred_username', ], ], 'AliasAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AliasAttributeType', ], ], 'AliasExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'AnalyticsConfigurationType' => [ 'type' => 'structure', 'members' => [ 'ApplicationId' => [ 'shape' => 'HexStringType', ], 'ApplicationArn' => [ 'shape' => 'ArnType', ], 'RoleArn' => [ 'shape' => 'ArnType', ], 'ExternalId' => [ 'shape' => 'StringType', ], 'UserDataShared' => [ 'shape' => 'BooleanType', ], ], ], 'AnalyticsMetadataType' => [ 'type' => 'structure', 'members' => [ 'AnalyticsEndpointId' => [ 'shape' => 'StringType', ], ], ], 'ArnType' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?', ], 'AssociateSoftwareTokenRequest' => [ 'type' => 'structure', 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'Session' => [ 'shape' => 'SessionType', ], ], ], 'AssociateSoftwareTokenResponse' => [ 'type' => 'structure', 'members' => [ 'SecretCode' => [ 'shape' => 'SecretCodeType', ], 'Session' => [ 'shape' => 'SessionType', ], ], ], 'AttributeDataType' => [ 'type' => 'string', 'enum' => [ 'String', 'Number', 'DateTime', 'Boolean', ], ], 'AttributeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeType', ], ], 'AttributeMappingKeyType' => [ 'type' => 'string', 'max' => 32, 'min' => 1, ], 'AttributeMappingType' => [ 'type' => 'map', 'key' => [ 'shape' => 'AttributeMappingKeyType', ], 'value' => [ 'shape' => 'StringType', ], ], 'AttributeNameListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeNameType', ], ], 'AttributeNameType' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'AttributeType' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'AttributeNameType', ], 'Value' => [ 'shape' => 'AttributeValueType', ], ], ], 'AttributeValueType' => [ 'type' => 'string', 'max' => 2048, 'sensitive' => true, ], 'AttributesRequireVerificationBeforeUpdateType' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedAttributeType', ], ], 'AuthEventType' => [ 'type' => 'structure', 'members' => [ 'EventId' => [ 'shape' => 'StringType', ], 'EventType' => [ 'shape' => 'EventType', ], 'CreationDate' => [ 'shape' => 'DateType', ], 'EventResponse' => [ 'shape' => 'EventResponseType', ], 'EventRisk' => [ 'shape' => 'EventRiskType', ], 'ChallengeResponses' => [ 'shape' => 'ChallengeResponseListType', ], 'EventContextData' => [ 'shape' => 'EventContextDataType', ], 'EventFeedback' => [ 'shape' => 'EventFeedbackType', ], ], ], 'AuthEventsType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthEventType', ], ], 'AuthFlowType' => [ 'type' => 'string', 'enum' => [ 'USER_SRP_AUTH', 'REFRESH_TOKEN_AUTH', 'REFRESH_TOKEN', 'CUSTOM_AUTH', 'ADMIN_NO_SRP_AUTH', 'USER_PASSWORD_AUTH', 'ADMIN_USER_PASSWORD_AUTH', ], ], 'AuthParametersType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], 'sensitive' => true, ], 'AuthSessionValidityType' => [ 'type' => 'integer', 'max' => 15, 'min' => 3, ], 'AuthenticationResultType' => [ 'type' => 'structure', 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'ExpiresIn' => [ 'shape' => 'IntegerType', ], 'TokenType' => [ 'shape' => 'StringType', ], 'RefreshToken' => [ 'shape' => 'TokenModelType', ], 'IdToken' => [ 'shape' => 'TokenModelType', ], 'NewDeviceMetadata' => [ 'shape' => 'NewDeviceMetadataType', ], ], ], 'BlockedIPRangeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringType', ], 'max' => 200, ], 'BooleanType' => [ 'type' => 'boolean', ], 'CSSType' => [ 'type' => 'string', 'max' => 131072, 'min' => 0, ], 'CSSVersionType' => [ 'type' => 'string', ], 'CallbackURLsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'RedirectUrlType', ], 'max' => 100, 'min' => 0, ], 'ChallengeName' => [ 'type' => 'string', 'enum' => [ 'Password', 'Mfa', ], ], 'ChallengeNameType' => [ 'type' => 'string', 'enum' => [ 'SMS_MFA', 'SOFTWARE_TOKEN_MFA', 'SELECT_MFA_TYPE', 'MFA_SETUP', 'PASSWORD_VERIFIER', 'CUSTOM_CHALLENGE', 'DEVICE_SRP_AUTH', 'DEVICE_PASSWORD_VERIFIER', 'ADMIN_NO_SRP_AUTH', 'NEW_PASSWORD_REQUIRED', ], ], 'ChallengeParametersType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], ], 'ChallengeResponse' => [ 'type' => 'string', 'enum' => [ 'Success', 'Failure', ], ], 'ChallengeResponseListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChallengeResponseType', ], ], 'ChallengeResponseType' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeName', ], 'ChallengeResponse' => [ 'shape' => 'ChallengeResponse', ], ], ], 'ChallengeResponsesType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], ], 'ChangePasswordRequest' => [ 'type' => 'structure', 'required' => [ 'PreviousPassword', 'ProposedPassword', 'AccessToken', ], 'members' => [ 'PreviousPassword' => [ 'shape' => 'PasswordType', ], 'ProposedPassword' => [ 'shape' => 'PasswordType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'ChangePasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'ClientIdType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w+]+', 'sensitive' => true, ], 'ClientMetadataType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], ], 'ClientNameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w\\s+=,.@-]+', ], 'ClientPermissionListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClientPermissionType', ], ], 'ClientPermissionType' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'ClientSecretType' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\w+]+', 'sensitive' => true, ], 'CloudWatchLogsConfigurationType' => [ 'type' => 'structure', 'members' => [ 'LogGroupArn' => [ 'shape' => 'ArnType', ], ], ], 'CodeDeliveryDetailsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeDeliveryDetailsType', ], ], 'CodeDeliveryDetailsType' => [ 'type' => 'structure', 'members' => [ 'Destination' => [ 'shape' => 'StringType', ], 'DeliveryMedium' => [ 'shape' => 'DeliveryMediumType', ], 'AttributeName' => [ 'shape' => 'AttributeNameType', ], ], ], 'CodeDeliveryFailureException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'CodeMismatchException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'CompletionMessageType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w]+', ], 'CompromisedCredentialsActionsType' => [ 'type' => 'structure', 'required' => [ 'EventAction', ], 'members' => [ 'EventAction' => [ 'shape' => 'CompromisedCredentialsEventActionType', ], ], ], 'CompromisedCredentialsEventActionType' => [ 'type' => 'string', 'enum' => [ 'BLOCK', 'NO_ACTION', ], ], 'CompromisedCredentialsRiskConfigurationType' => [ 'type' => 'structure', 'required' => [ 'Actions', ], 'members' => [ 'EventFilter' => [ 'shape' => 'EventFiltersType', ], 'Actions' => [ 'shape' => 'CompromisedCredentialsActionsType', ], ], ], 'ConcurrentModificationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ConfirmDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'DeviceKey', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceSecretVerifierConfig' => [ 'shape' => 'DeviceSecretVerifierConfigType', ], 'DeviceName' => [ 'shape' => 'DeviceNameType', ], ], ], 'ConfirmDeviceResponse' => [ 'type' => 'structure', 'members' => [ 'UserConfirmationNecessary' => [ 'shape' => 'BooleanType', ], ], ], 'ConfirmForgotPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', 'ConfirmationCode', 'Password', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'ConfirmationCode' => [ 'shape' => 'ConfirmationCodeType', ], 'Password' => [ 'shape' => 'PasswordType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'ConfirmForgotPasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'ConfirmSignUpRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', 'ConfirmationCode', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'ConfirmationCode' => [ 'shape' => 'ConfirmationCodeType', ], 'ForceAliasCreation' => [ 'shape' => 'ForceAliasCreation', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'ConfirmSignUpResponse' => [ 'type' => 'structure', 'members' => [], ], 'ConfirmationCodeType' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[\\S]+', ], 'ContextDataType' => [ 'type' => 'structure', 'required' => [ 'IpAddress', 'ServerName', 'ServerPath', 'HttpHeaders', ], 'members' => [ 'IpAddress' => [ 'shape' => 'StringType', ], 'ServerName' => [ 'shape' => 'StringType', ], 'ServerPath' => [ 'shape' => 'StringType', ], 'HttpHeaders' => [ 'shape' => 'HttpHeaderList', ], 'EncodedData' => [ 'shape' => 'StringType', ], ], ], 'CreateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'UserPoolId', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Description' => [ 'shape' => 'DescriptionType', ], 'RoleArn' => [ 'shape' => 'ArnType', ], 'Precedence' => [ 'shape' => 'PrecedenceType', ], ], ], 'CreateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'GroupType', ], ], ], 'CreateIdentityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ProviderName', 'ProviderType', 'ProviderDetails', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameTypeV1', ], 'ProviderType' => [ 'shape' => 'IdentityProviderTypeType', ], 'ProviderDetails' => [ 'shape' => 'ProviderDetailsType', ], 'AttributeMapping' => [ 'shape' => 'AttributeMappingType', ], 'IdpIdentifiers' => [ 'shape' => 'IdpIdentifiersListType', ], ], ], 'CreateIdentityProviderResponse' => [ 'type' => 'structure', 'required' => [ 'IdentityProvider', ], 'members' => [ 'IdentityProvider' => [ 'shape' => 'IdentityProviderType', ], ], ], 'CreateResourceServerRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Identifier', 'Name', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], 'Name' => [ 'shape' => 'ResourceServerNameType', ], 'Scopes' => [ 'shape' => 'ResourceServerScopeListType', ], ], ], 'CreateResourceServerResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceServer', ], 'members' => [ 'ResourceServer' => [ 'shape' => 'ResourceServerType', ], ], ], 'CreateUserImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', 'UserPoolId', 'CloudWatchLogsRoleArn', ], 'members' => [ 'JobName' => [ 'shape' => 'UserImportJobNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CloudWatchLogsRoleArn' => [ 'shape' => 'ArnType', ], ], ], 'CreateUserImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJob' => [ 'shape' => 'UserImportJobType', ], ], ], 'CreateUserPoolClientRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientName' => [ 'shape' => 'ClientNameType', ], 'GenerateSecret' => [ 'shape' => 'GenerateSecret', ], 'RefreshTokenValidity' => [ 'shape' => 'RefreshTokenValidityType', ], 'AccessTokenValidity' => [ 'shape' => 'AccessTokenValidityType', ], 'IdTokenValidity' => [ 'shape' => 'IdTokenValidityType', ], 'TokenValidityUnits' => [ 'shape' => 'TokenValidityUnitsType', ], 'ReadAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'WriteAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'ExplicitAuthFlows' => [ 'shape' => 'ExplicitAuthFlowsListType', ], 'SupportedIdentityProviders' => [ 'shape' => 'SupportedIdentityProvidersListType', ], 'CallbackURLs' => [ 'shape' => 'CallbackURLsListType', ], 'LogoutURLs' => [ 'shape' => 'LogoutURLsListType', ], 'DefaultRedirectURI' => [ 'shape' => 'RedirectUrlType', ], 'AllowedOAuthFlows' => [ 'shape' => 'OAuthFlowsType', ], 'AllowedOAuthScopes' => [ 'shape' => 'ScopeListType', ], 'AllowedOAuthFlowsUserPoolClient' => [ 'shape' => 'BooleanType', ], 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfigurationType', ], 'PreventUserExistenceErrors' => [ 'shape' => 'PreventUserExistenceErrorTypes', ], 'EnableTokenRevocation' => [ 'shape' => 'WrappedBooleanType', ], 'EnablePropagateAdditionalUserContextData' => [ 'shape' => 'WrappedBooleanType', ], 'AuthSessionValidity' => [ 'shape' => 'AuthSessionValidityType', ], ], ], 'CreateUserPoolClientResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolClient' => [ 'shape' => 'UserPoolClientType', ], ], ], 'CreateUserPoolDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Domain', 'UserPoolId', ], 'members' => [ 'Domain' => [ 'shape' => 'DomainType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CustomDomainConfig' => [ 'shape' => 'CustomDomainConfigType', ], ], ], 'CreateUserPoolDomainResponse' => [ 'type' => 'structure', 'members' => [ 'CloudFrontDomain' => [ 'shape' => 'DomainType', ], ], ], 'CreateUserPoolRequest' => [ 'type' => 'structure', 'required' => [ 'PoolName', ], 'members' => [ 'PoolName' => [ 'shape' => 'UserPoolNameType', ], 'Policies' => [ 'shape' => 'UserPoolPolicyType', ], 'DeletionProtection' => [ 'shape' => 'DeletionProtectionType', ], 'LambdaConfig' => [ 'shape' => 'LambdaConfigType', ], 'AutoVerifiedAttributes' => [ 'shape' => 'VerifiedAttributesListType', ], 'AliasAttributes' => [ 'shape' => 'AliasAttributesListType', ], 'UsernameAttributes' => [ 'shape' => 'UsernameAttributesListType', ], 'SmsVerificationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailVerificationMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailVerificationSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], 'VerificationMessageTemplate' => [ 'shape' => 'VerificationMessageTemplateType', ], 'SmsAuthenticationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], 'UserAttributeUpdateSettings' => [ 'shape' => 'UserAttributeUpdateSettingsType', ], 'DeviceConfiguration' => [ 'shape' => 'DeviceConfigurationType', ], 'EmailConfiguration' => [ 'shape' => 'EmailConfigurationType', ], 'SmsConfiguration' => [ 'shape' => 'SmsConfigurationType', ], 'UserPoolTags' => [ 'shape' => 'UserPoolTagsType', ], 'AdminCreateUserConfig' => [ 'shape' => 'AdminCreateUserConfigType', ], 'Schema' => [ 'shape' => 'SchemaAttributesListType', ], 'UserPoolAddOns' => [ 'shape' => 'UserPoolAddOnsType', ], 'UsernameConfiguration' => [ 'shape' => 'UsernameConfigurationType', ], 'AccountRecoverySetting' => [ 'shape' => 'AccountRecoverySettingType', ], ], ], 'CreateUserPoolResponse' => [ 'type' => 'structure', 'members' => [ 'UserPool' => [ 'shape' => 'UserPoolType', ], ], ], 'CustomAttributeNameType' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'CustomAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'SchemaAttributeType', ], 'max' => 25, 'min' => 1, ], 'CustomDomainConfigType' => [ 'type' => 'structure', 'required' => [ 'CertificateArn', ], 'members' => [ 'CertificateArn' => [ 'shape' => 'ArnType', ], ], ], 'CustomEmailLambdaVersionConfigType' => [ 'type' => 'structure', 'required' => [ 'LambdaVersion', 'LambdaArn', ], 'members' => [ 'LambdaVersion' => [ 'shape' => 'CustomEmailSenderLambdaVersionType', ], 'LambdaArn' => [ 'shape' => 'ArnType', ], ], ], 'CustomEmailSenderLambdaVersionType' => [ 'type' => 'string', 'enum' => [ 'V1_0', ], ], 'CustomSMSLambdaVersionConfigType' => [ 'type' => 'structure', 'required' => [ 'LambdaVersion', 'LambdaArn', ], 'members' => [ 'LambdaVersion' => [ 'shape' => 'CustomSMSSenderLambdaVersionType', ], 'LambdaArn' => [ 'shape' => 'ArnType', ], ], ], 'CustomSMSSenderLambdaVersionType' => [ 'type' => 'string', 'enum' => [ 'V1_0', ], ], 'DateType' => [ 'type' => 'timestamp', ], 'DefaultEmailOptionType' => [ 'type' => 'string', 'enum' => [ 'CONFIRM_WITH_LINK', 'CONFIRM_WITH_CODE', ], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'UserPoolId', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'DeleteIdentityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ProviderName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameType', ], ], ], 'DeleteResourceServerRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Identifier', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], ], ], 'DeleteUserAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserAttributeNames', 'AccessToken', ], 'members' => [ 'UserAttributeNames' => [ 'shape' => 'AttributeNameListType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'DeleteUserAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUserPoolClientRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], ], ], 'DeleteUserPoolDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Domain', 'UserPoolId', ], 'members' => [ 'Domain' => [ 'shape' => 'DomainType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'DeleteUserPoolDomainResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUserPoolRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'DeletionProtectionType' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'DeliveryMediumListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeliveryMediumType', ], ], 'DeliveryMediumType' => [ 'type' => 'string', 'enum' => [ 'SMS', 'EMAIL', ], ], 'DescribeIdentityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ProviderName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameType', ], ], ], 'DescribeIdentityProviderResponse' => [ 'type' => 'structure', 'required' => [ 'IdentityProvider', ], 'members' => [ 'IdentityProvider' => [ 'shape' => 'IdentityProviderType', ], ], ], 'DescribeResourceServerRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Identifier', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], ], ], 'DescribeResourceServerResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceServer', ], 'members' => [ 'ResourceServer' => [ 'shape' => 'ResourceServerType', ], ], ], 'DescribeRiskConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], ], ], 'DescribeRiskConfigurationResponse' => [ 'type' => 'structure', 'required' => [ 'RiskConfiguration', ], 'members' => [ 'RiskConfiguration' => [ 'shape' => 'RiskConfigurationType', ], ], ], 'DescribeUserImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'JobId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'JobId' => [ 'shape' => 'UserImportJobIdType', ], ], ], 'DescribeUserImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJob' => [ 'shape' => 'UserImportJobType', ], ], ], 'DescribeUserPoolClientRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], ], ], 'DescribeUserPoolClientResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolClient' => [ 'shape' => 'UserPoolClientType', ], ], ], 'DescribeUserPoolDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Domain', ], 'members' => [ 'Domain' => [ 'shape' => 'DomainType', ], ], ], 'DescribeUserPoolDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainDescription' => [ 'shape' => 'DomainDescriptionType', ], ], ], 'DescribeUserPoolRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'DescribeUserPoolResponse' => [ 'type' => 'structure', 'members' => [ 'UserPool' => [ 'shape' => 'UserPoolType', ], ], ], 'DescriptionType' => [ 'type' => 'string', 'max' => 2048, ], 'DeviceConfigurationType' => [ 'type' => 'structure', 'members' => [ 'ChallengeRequiredOnNewDevice' => [ 'shape' => 'BooleanType', ], 'DeviceOnlyRememberedOnUserPrompt' => [ 'shape' => 'BooleanType', ], ], ], 'DeviceKeyType' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-f-]+', ], 'DeviceListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceType', ], ], 'DeviceNameType' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'DeviceRememberedStatusType' => [ 'type' => 'string', 'enum' => [ 'remembered', 'not_remembered', ], ], 'DeviceSecretVerifierConfigType' => [ 'type' => 'structure', 'members' => [ 'PasswordVerifier' => [ 'shape' => 'StringType', ], 'Salt' => [ 'shape' => 'StringType', ], ], ], 'DeviceType' => [ 'type' => 'structure', 'members' => [ 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceAttributes' => [ 'shape' => 'AttributeListType', ], 'DeviceCreateDate' => [ 'shape' => 'DateType', ], 'DeviceLastModifiedDate' => [ 'shape' => 'DateType', ], 'DeviceLastAuthenticatedDate' => [ 'shape' => 'DateType', ], ], ], 'DomainDescriptionType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'AWSAccountId' => [ 'shape' => 'AWSAccountIdType', ], 'Domain' => [ 'shape' => 'DomainType', ], 'S3Bucket' => [ 'shape' => 'S3BucketType', ], 'CloudFrontDistribution' => [ 'shape' => 'StringType', ], 'Version' => [ 'shape' => 'DomainVersionType', ], 'Status' => [ 'shape' => 'DomainStatusType', ], 'CustomDomainConfig' => [ 'shape' => 'CustomDomainConfigType', ], ], ], 'DomainStatusType' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'DELETING', 'UPDATING', 'ACTIVE', 'FAILED', ], ], 'DomainType' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$', ], 'DomainVersionType' => [ 'type' => 'string', 'max' => 20, 'min' => 1, ], 'DuplicateProviderException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'EmailAddressType' => [ 'type' => 'string', 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+@[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'EmailConfigurationType' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'ArnType', ], 'ReplyToEmailAddress' => [ 'shape' => 'EmailAddressType', ], 'EmailSendingAccount' => [ 'shape' => 'EmailSendingAccountType', ], 'From' => [ 'shape' => 'StringType', ], 'ConfigurationSet' => [ 'shape' => 'SESConfigurationSet', ], ], ], 'EmailNotificationBodyType' => [ 'type' => 'string', 'max' => 20000, 'min' => 6, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]+', ], 'EmailNotificationSubjectType' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+', ], 'EmailSendingAccountType' => [ 'type' => 'string', 'enum' => [ 'COGNITO_DEFAULT', 'DEVELOPER', ], ], 'EmailVerificationMessageByLinkType' => [ 'type' => 'string', 'max' => 20000, 'min' => 6, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*', ], 'EmailVerificationMessageType' => [ 'type' => 'string', 'max' => 20000, 'min' => 6, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*', ], 'EmailVerificationSubjectByLinkType' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+', ], 'EmailVerificationSubjectType' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+', ], 'EnableSoftwareTokenMFAException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'EventContextDataType' => [ 'type' => 'structure', 'members' => [ 'IpAddress' => [ 'shape' => 'StringType', ], 'DeviceName' => [ 'shape' => 'StringType', ], 'Timezone' => [ 'shape' => 'StringType', ], 'City' => [ 'shape' => 'StringType', ], 'Country' => [ 'shape' => 'StringType', ], ], ], 'EventFeedbackType' => [ 'type' => 'structure', 'required' => [ 'FeedbackValue', 'Provider', ], 'members' => [ 'FeedbackValue' => [ 'shape' => 'FeedbackValueType', ], 'Provider' => [ 'shape' => 'StringType', ], 'FeedbackDate' => [ 'shape' => 'DateType', ], ], ], 'EventFilterType' => [ 'type' => 'string', 'enum' => [ 'SIGN_IN', 'PASSWORD_CHANGE', 'SIGN_UP', ], ], 'EventFiltersType' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventFilterType', ], ], 'EventIdType' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '[\\w+-]+', ], 'EventResponseType' => [ 'type' => 'string', 'enum' => [ 'Pass', 'Fail', 'InProgress', ], ], 'EventRiskType' => [ 'type' => 'structure', 'members' => [ 'RiskDecision' => [ 'shape' => 'RiskDecisionType', ], 'RiskLevel' => [ 'shape' => 'RiskLevelType', ], 'CompromisedCredentialsDetected' => [ 'shape' => 'WrappedBooleanType', ], ], ], 'EventSourceName' => [ 'type' => 'string', 'enum' => [ 'userNotification', ], ], 'EventType' => [ 'type' => 'string', 'enum' => [ 'SignIn', 'SignUp', 'ForgotPassword', 'PasswordChange', 'ResendCode', ], ], 'ExpiredCodeException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ExplicitAuthFlowsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExplicitAuthFlowsType', ], ], 'ExplicitAuthFlowsType' => [ 'type' => 'string', 'enum' => [ 'ADMIN_NO_SRP_AUTH', 'CUSTOM_AUTH_FLOW_ONLY', 'USER_PASSWORD_AUTH', 'ALLOW_ADMIN_USER_PASSWORD_AUTH', 'ALLOW_CUSTOM_AUTH', 'ALLOW_USER_PASSWORD_AUTH', 'ALLOW_USER_SRP_AUTH', 'ALLOW_REFRESH_TOKEN_AUTH', ], ], 'FeedbackValueType' => [ 'type' => 'string', 'enum' => [ 'Valid', 'Invalid', ], ], 'ForbiddenException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ForceAliasCreation' => [ 'type' => 'boolean', ], 'ForgetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceKey', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], ], ], 'ForgotPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'ForgotPasswordResponse' => [ 'type' => 'structure', 'members' => [ 'CodeDeliveryDetails' => [ 'shape' => 'CodeDeliveryDetailsType', ], ], ], 'GenerateSecret' => [ 'type' => 'boolean', ], 'GetCSVHeaderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'GetCSVHeaderResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CSVHeader' => [ 'shape' => 'ListOfStringTypes', ], ], ], 'GetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceKey', ], 'members' => [ 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'GetDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'Device', ], 'members' => [ 'Device' => [ 'shape' => 'DeviceType', ], ], ], 'GetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'UserPoolId', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'GetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'GroupType', ], ], ], 'GetIdentityProviderByIdentifierRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'IdpIdentifier', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'IdpIdentifier' => [ 'shape' => 'IdpIdentifierType', ], ], ], 'GetIdentityProviderByIdentifierResponse' => [ 'type' => 'structure', 'required' => [ 'IdentityProvider', ], 'members' => [ 'IdentityProvider' => [ 'shape' => 'IdentityProviderType', ], ], ], 'GetLogDeliveryConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'GetLogDeliveryConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LogDeliveryConfiguration' => [ 'shape' => 'LogDeliveryConfigurationType', ], ], ], 'GetSigningCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'GetSigningCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'Certificate' => [ 'shape' => 'StringType', ], ], ], 'GetUICustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], ], ], 'GetUICustomizationResponse' => [ 'type' => 'structure', 'required' => [ 'UICustomization', ], 'members' => [ 'UICustomization' => [ 'shape' => 'UICustomizationType', ], ], ], 'GetUserAttributeVerificationCodeRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'AttributeName', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'AttributeName' => [ 'shape' => 'AttributeNameType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'GetUserAttributeVerificationCodeResponse' => [ 'type' => 'structure', 'members' => [ 'CodeDeliveryDetails' => [ 'shape' => 'CodeDeliveryDetailsType', ], ], ], 'GetUserPoolMfaConfigRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], ], ], 'GetUserPoolMfaConfigResponse' => [ 'type' => 'structure', 'members' => [ 'SmsMfaConfiguration' => [ 'shape' => 'SmsMfaConfigType', ], 'SoftwareTokenMfaConfiguration' => [ 'shape' => 'SoftwareTokenMfaConfigType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], ], ], 'GetUserRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'GetUserResponse' => [ 'type' => 'structure', 'required' => [ 'Username', 'UserAttributes', ], 'members' => [ 'Username' => [ 'shape' => 'UsernameType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], 'PreferredMfaSetting' => [ 'shape' => 'StringType', ], 'UserMFASettingList' => [ 'shape' => 'UserMFASettingListType', ], ], ], 'GlobalSignOutRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'GlobalSignOutResponse' => [ 'type' => 'structure', 'members' => [], ], 'GroupExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'GroupListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupType', ], ], 'GroupNameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'GroupType' => [ 'type' => 'structure', 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Description' => [ 'shape' => 'DescriptionType', ], 'RoleArn' => [ 'shape' => 'ArnType', ], 'Precedence' => [ 'shape' => 'PrecedenceType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'HexStringType' => [ 'type' => 'string', 'pattern' => '^[0-9a-fA-F]+$', ], 'HttpHeader' => [ 'type' => 'structure', 'members' => [ 'headerName' => [ 'shape' => 'StringType', ], 'headerValue' => [ 'shape' => 'StringType', ], ], ], 'HttpHeaderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HttpHeader', ], ], 'IdTokenValidityType' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'IdentityProviderType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameType', ], 'ProviderType' => [ 'shape' => 'IdentityProviderTypeType', ], 'ProviderDetails' => [ 'shape' => 'ProviderDetailsType', ], 'AttributeMapping' => [ 'shape' => 'AttributeMappingType', ], 'IdpIdentifiers' => [ 'shape' => 'IdpIdentifiersListType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'IdentityProviderTypeType' => [ 'type' => 'string', 'enum' => [ 'SAML', 'Facebook', 'Google', 'LoginWithAmazon', 'SignInWithApple', 'OIDC', ], ], 'IdpIdentifierType' => [ 'type' => 'string', 'max' => 40, 'min' => 1, 'pattern' => '[\\w\\s+=.@-]+', ], 'IdpIdentifiersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'IdpIdentifierType', ], 'max' => 50, 'min' => 0, ], 'ImageFileType' => [ 'type' => 'blob', 'max' => 131072, 'min' => 0, ], 'ImageUrlType' => [ 'type' => 'string', ], 'InitiateAuthRequest' => [ 'type' => 'structure', 'required' => [ 'AuthFlow', 'ClientId', ], 'members' => [ 'AuthFlow' => [ 'shape' => 'AuthFlowType', ], 'AuthParameters' => [ 'shape' => 'AuthParametersType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], ], ], 'InitiateAuthResponse' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeParameters' => [ 'shape' => 'ChallengeParametersType', ], 'AuthenticationResult' => [ 'shape' => 'AuthenticationResultType', ], ], ], 'IntegerType' => [ 'type' => 'integer', ], 'InternalErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, 'fault' => true, ], 'InvalidEmailRoleAccessPolicyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidLambdaResponseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidOAuthFlowException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidPasswordException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidSmsRoleAccessPolicyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidSmsRoleTrustRelationshipException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'InvalidUserPoolConfigurationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'LambdaConfigType' => [ 'type' => 'structure', 'members' => [ 'PreSignUp' => [ 'shape' => 'ArnType', ], 'CustomMessage' => [ 'shape' => 'ArnType', ], 'PostConfirmation' => [ 'shape' => 'ArnType', ], 'PreAuthentication' => [ 'shape' => 'ArnType', ], 'PostAuthentication' => [ 'shape' => 'ArnType', ], 'DefineAuthChallenge' => [ 'shape' => 'ArnType', ], 'CreateAuthChallenge' => [ 'shape' => 'ArnType', ], 'VerifyAuthChallengeResponse' => [ 'shape' => 'ArnType', ], 'PreTokenGeneration' => [ 'shape' => 'ArnType', ], 'UserMigration' => [ 'shape' => 'ArnType', ], 'CustomSMSSender' => [ 'shape' => 'CustomSMSLambdaVersionConfigType', ], 'CustomEmailSender' => [ 'shape' => 'CustomEmailLambdaVersionConfigType', ], 'KMSKeyID' => [ 'shape' => 'ArnType', ], ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ListDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'ListDevicesResponse' => [ 'type' => 'structure', 'members' => [ 'Devices' => [ 'shape' => 'DeviceListType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'GroupListType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListIdentityProvidersRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'MaxResults' => [ 'shape' => 'ListProvidersLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListIdentityProvidersResponse' => [ 'type' => 'structure', 'required' => [ 'Providers', ], 'members' => [ 'Providers' => [ 'shape' => 'ProvidersListType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListOfStringTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringType', ], ], 'ListProvidersLimitType' => [ 'type' => 'integer', 'max' => 60, 'min' => 0, ], 'ListResourceServersLimitType' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListResourceServersRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'MaxResults' => [ 'shape' => 'ListResourceServersLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListResourceServersResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceServers', ], 'members' => [ 'ResourceServers' => [ 'shape' => 'ResourceServersListType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ArnType', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'UserPoolTagsType', ], ], ], 'ListUserImportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'MaxResults', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'MaxResults' => [ 'shape' => 'PoolQueryLimitType', ], 'PaginationToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListUserImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJobs' => [ 'shape' => 'UserImportJobsListType', ], 'PaginationToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListUserPoolClientsRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'MaxResults' => [ 'shape' => 'QueryLimit', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListUserPoolClientsResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolClients' => [ 'shape' => 'UserPoolClientListType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListUserPoolsRequest' => [ 'type' => 'structure', 'required' => [ 'MaxResults', ], 'members' => [ 'NextToken' => [ 'shape' => 'PaginationKeyType', ], 'MaxResults' => [ 'shape' => 'PoolQueryLimitType', ], ], ], 'ListUserPoolsResponse' => [ 'type' => 'structure', 'members' => [ 'UserPools' => [ 'shape' => 'UserPoolListType', ], 'NextToken' => [ 'shape' => 'PaginationKeyType', ], ], ], 'ListUsersInGroupRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'GroupName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'GroupName' => [ 'shape' => 'GroupNameType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListUsersInGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'UsersListType', ], 'NextToken' => [ 'shape' => 'PaginationKey', ], ], ], 'ListUsersRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'AttributesToGet' => [ 'shape' => 'SearchedAttributeNamesListType', ], 'Limit' => [ 'shape' => 'QueryLimitType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], 'Filter' => [ 'shape' => 'UserFilterType', ], ], ], 'ListUsersResponse' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'UsersListType', ], 'PaginationToken' => [ 'shape' => 'SearchPaginationTokenType', ], ], ], 'LogConfigurationListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogConfigurationType', ], 'max' => 1, 'min' => 0, ], 'LogConfigurationType' => [ 'type' => 'structure', 'required' => [ 'LogLevel', 'EventSource', ], 'members' => [ 'LogLevel' => [ 'shape' => 'LogLevel', ], 'EventSource' => [ 'shape' => 'EventSourceName', ], 'CloudWatchLogsConfiguration' => [ 'shape' => 'CloudWatchLogsConfigurationType', ], ], ], 'LogDeliveryConfigurationType' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'LogConfigurations', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'LogConfigurations' => [ 'shape' => 'LogConfigurationListType', ], ], ], 'LogLevel' => [ 'type' => 'string', 'enum' => [ 'ERROR', ], ], 'LogoutURLsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'RedirectUrlType', ], 'max' => 100, 'min' => 0, ], 'LongType' => [ 'type' => 'long', ], 'MFAMethodNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'MFAOptionListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'MFAOptionType', ], ], 'MFAOptionType' => [ 'type' => 'structure', 'members' => [ 'DeliveryMedium' => [ 'shape' => 'DeliveryMediumType', ], 'AttributeName' => [ 'shape' => 'AttributeNameType', ], ], ], 'MessageActionType' => [ 'type' => 'string', 'enum' => [ 'RESEND', 'SUPPRESS', ], ], 'MessageTemplateType' => [ 'type' => 'structure', 'members' => [ 'SMSMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], ], ], 'MessageType' => [ 'type' => 'string', ], 'NewDeviceMetadataType' => [ 'type' => 'structure', 'members' => [ 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceGroupKey' => [ 'shape' => 'StringType', ], ], ], 'NotAuthorizedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'NotifyConfigurationType' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'From' => [ 'shape' => 'StringType', ], 'ReplyTo' => [ 'shape' => 'StringType', ], 'SourceArn' => [ 'shape' => 'ArnType', ], 'BlockEmail' => [ 'shape' => 'NotifyEmailType', ], 'NoActionEmail' => [ 'shape' => 'NotifyEmailType', ], 'MfaEmail' => [ 'shape' => 'NotifyEmailType', ], ], ], 'NotifyEmailType' => [ 'type' => 'structure', 'required' => [ 'Subject', ], 'members' => [ 'Subject' => [ 'shape' => 'EmailNotificationSubjectType', ], 'HtmlBody' => [ 'shape' => 'EmailNotificationBodyType', ], 'TextBody' => [ 'shape' => 'EmailNotificationBodyType', ], ], ], 'NumberAttributeConstraintsType' => [ 'type' => 'structure', 'members' => [ 'MinValue' => [ 'shape' => 'StringType', ], 'MaxValue' => [ 'shape' => 'StringType', ], ], ], 'OAuthFlowType' => [ 'type' => 'string', 'enum' => [ 'code', 'implicit', 'client_credentials', ], ], 'OAuthFlowsType' => [ 'type' => 'list', 'member' => [ 'shape' => 'OAuthFlowType', ], 'max' => 3, 'min' => 0, ], 'PaginationKey' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\S]+', ], 'PaginationKeyType' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\S]+', ], 'PasswordPolicyMinLengthType' => [ 'type' => 'integer', 'max' => 99, 'min' => 6, ], 'PasswordPolicyType' => [ 'type' => 'structure', 'members' => [ 'MinimumLength' => [ 'shape' => 'PasswordPolicyMinLengthType', ], 'RequireUppercase' => [ 'shape' => 'BooleanType', ], 'RequireLowercase' => [ 'shape' => 'BooleanType', ], 'RequireNumbers' => [ 'shape' => 'BooleanType', ], 'RequireSymbols' => [ 'shape' => 'BooleanType', ], 'TemporaryPasswordValidityDays' => [ 'shape' => 'TemporaryPasswordValidityDaysType', ], ], ], 'PasswordResetRequiredException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'PasswordType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\S]+', 'sensitive' => true, ], 'PoolQueryLimitType' => [ 'type' => 'integer', 'max' => 60, 'min' => 1, ], 'PreSignedUrlType' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'PrecedenceType' => [ 'type' => 'integer', 'min' => 0, ], 'PreconditionNotMetException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'PreventUserExistenceErrorTypes' => [ 'type' => 'string', 'enum' => [ 'LEGACY', 'ENABLED', ], ], 'PriorityType' => [ 'type' => 'integer', 'max' => 2, 'min' => 1, ], 'ProviderDescription' => [ 'type' => 'structure', 'members' => [ 'ProviderName' => [ 'shape' => 'ProviderNameType', ], 'ProviderType' => [ 'shape' => 'IdentityProviderTypeType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'ProviderDetailsType' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringType', ], 'value' => [ 'shape' => 'StringType', ], ], 'ProviderNameType' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'ProviderNameTypeV1' => [ 'type' => 'string', 'max' => 32, 'min' => 3, 'pattern' => '[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+', ], 'ProviderUserIdentifierType' => [ 'type' => 'structure', 'members' => [ 'ProviderName' => [ 'shape' => 'ProviderNameType', ], 'ProviderAttributeName' => [ 'shape' => 'StringType', ], 'ProviderAttributeValue' => [ 'shape' => 'StringType', ], ], ], 'ProvidersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProviderDescription', ], 'max' => 50, 'min' => 0, ], 'QueryLimit' => [ 'type' => 'integer', 'max' => 60, 'min' => 1, ], 'QueryLimitType' => [ 'type' => 'integer', 'max' => 60, 'min' => 0, ], 'RecoveryMechanismsType' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecoveryOptionType', ], 'max' => 2, 'min' => 1, ], 'RecoveryOptionNameType' => [ 'type' => 'string', 'enum' => [ 'verified_email', 'verified_phone_number', 'admin_only', ], ], 'RecoveryOptionType' => [ 'type' => 'structure', 'required' => [ 'Priority', 'Name', ], 'members' => [ 'Priority' => [ 'shape' => 'PriorityType', ], 'Name' => [ 'shape' => 'RecoveryOptionNameType', ], ], ], 'RedirectUrlType' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'RefreshTokenValidityType' => [ 'type' => 'integer', 'max' => 315360000, 'min' => 0, ], 'RegionCodeType' => [ 'type' => 'string', 'max' => 32, 'min' => 5, ], 'ResendConfirmationCodeRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'ResendConfirmationCodeResponse' => [ 'type' => 'structure', 'members' => [ 'CodeDeliveryDetails' => [ 'shape' => 'CodeDeliveryDetailsType', ], ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ResourceServerIdentifierType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\x21\\x23-\\x5B\\x5D-\\x7E]+', ], 'ResourceServerNameType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\w\\s+=,.@-]+', ], 'ResourceServerScopeDescriptionType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ResourceServerScopeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceServerScopeType', ], 'max' => 100, ], 'ResourceServerScopeNameType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\x21\\x23-\\x2E\\x30-\\x5B\\x5D-\\x7E]+', ], 'ResourceServerScopeType' => [ 'type' => 'structure', 'required' => [ 'ScopeName', 'ScopeDescription', ], 'members' => [ 'ScopeName' => [ 'shape' => 'ResourceServerScopeNameType', ], 'ScopeDescription' => [ 'shape' => 'ResourceServerScopeDescriptionType', ], ], ], 'ResourceServerType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], 'Name' => [ 'shape' => 'ResourceServerNameType', ], 'Scopes' => [ 'shape' => 'ResourceServerScopeListType', ], ], ], 'ResourceServersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceServerType', ], ], 'RespondToAuthChallengeRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'ChallengeName', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeResponses' => [ 'shape' => 'ChallengeResponsesType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'RespondToAuthChallengeResponse' => [ 'type' => 'structure', 'members' => [ 'ChallengeName' => [ 'shape' => 'ChallengeNameType', ], 'Session' => [ 'shape' => 'SessionType', ], 'ChallengeParameters' => [ 'shape' => 'ChallengeParametersType', ], 'AuthenticationResult' => [ 'shape' => 'AuthenticationResultType', ], ], ], 'RevokeTokenRequest' => [ 'type' => 'structure', 'required' => [ 'Token', 'ClientId', ], 'members' => [ 'Token' => [ 'shape' => 'TokenModelType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ClientSecret' => [ 'shape' => 'ClientSecretType', ], ], ], 'RevokeTokenResponse' => [ 'type' => 'structure', 'members' => [], ], 'RiskConfigurationType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'CompromisedCredentialsRiskConfiguration' => [ 'shape' => 'CompromisedCredentialsRiskConfigurationType', ], 'AccountTakeoverRiskConfiguration' => [ 'shape' => 'AccountTakeoverRiskConfigurationType', ], 'RiskExceptionConfiguration' => [ 'shape' => 'RiskExceptionConfigurationType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], ], ], 'RiskDecisionType' => [ 'type' => 'string', 'enum' => [ 'NoRisk', 'AccountTakeover', 'Block', ], ], 'RiskExceptionConfigurationType' => [ 'type' => 'structure', 'members' => [ 'BlockedIPRangeList' => [ 'shape' => 'BlockedIPRangeListType', ], 'SkippedIPRangeList' => [ 'shape' => 'SkippedIPRangeListType', ], ], ], 'RiskLevelType' => [ 'type' => 'string', 'enum' => [ 'Low', 'Medium', 'High', ], ], 'S3BucketType' => [ 'type' => 'string', 'max' => 1024, 'min' => 3, 'pattern' => '^[0-9A-Za-z\\.\\-_]*(? [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_-]+$', ], 'SMSMfaSettingsType' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'BooleanType', ], 'PreferredMfa' => [ 'shape' => 'BooleanType', ], ], ], 'SchemaAttributeType' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'CustomAttributeNameType', ], 'AttributeDataType' => [ 'shape' => 'AttributeDataType', ], 'DeveloperOnlyAttribute' => [ 'shape' => 'BooleanType', 'box' => true, ], 'Mutable' => [ 'shape' => 'BooleanType', 'box' => true, ], 'Required' => [ 'shape' => 'BooleanType', 'box' => true, ], 'NumberAttributeConstraints' => [ 'shape' => 'NumberAttributeConstraintsType', ], 'StringAttributeConstraints' => [ 'shape' => 'StringAttributeConstraintsType', ], ], ], 'SchemaAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'SchemaAttributeType', ], 'max' => 50, 'min' => 1, ], 'ScopeDoesNotExistException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'ScopeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScopeType', ], 'max' => 50, ], 'ScopeType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\x21\\x23-\\x5B\\x5D-\\x7E]+', ], 'SearchPaginationTokenType' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\S]+', ], 'SearchedAttributeNamesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeNameType', ], ], 'SecretCodeType' => [ 'type' => 'string', 'min' => 16, 'pattern' => '[A-Za-z0-9]+', 'sensitive' => true, ], 'SecretHashType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w+=/]+', 'sensitive' => true, ], 'SessionType' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'SetLogDeliveryConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'LogConfigurations', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'LogConfigurations' => [ 'shape' => 'LogConfigurationListType', ], ], ], 'SetLogDeliveryConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LogDeliveryConfiguration' => [ 'shape' => 'LogDeliveryConfigurationType', ], ], ], 'SetRiskConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'CompromisedCredentialsRiskConfiguration' => [ 'shape' => 'CompromisedCredentialsRiskConfigurationType', ], 'AccountTakeoverRiskConfiguration' => [ 'shape' => 'AccountTakeoverRiskConfigurationType', ], 'RiskExceptionConfiguration' => [ 'shape' => 'RiskExceptionConfigurationType', ], ], ], 'SetRiskConfigurationResponse' => [ 'type' => 'structure', 'required' => [ 'RiskConfiguration', ], 'members' => [ 'RiskConfiguration' => [ 'shape' => 'RiskConfigurationType', ], ], ], 'SetUICustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'CSS' => [ 'shape' => 'CSSType', ], 'ImageFile' => [ 'shape' => 'ImageFileType', ], ], ], 'SetUICustomizationResponse' => [ 'type' => 'structure', 'required' => [ 'UICustomization', ], 'members' => [ 'UICustomization' => [ 'shape' => 'UICustomizationType', ], ], ], 'SetUserMFAPreferenceRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', ], 'members' => [ 'SMSMfaSettings' => [ 'shape' => 'SMSMfaSettingsType', ], 'SoftwareTokenMfaSettings' => [ 'shape' => 'SoftwareTokenMfaSettingsType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], ], ], 'SetUserMFAPreferenceResponse' => [ 'type' => 'structure', 'members' => [], ], 'SetUserPoolMfaConfigRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'SmsMfaConfiguration' => [ 'shape' => 'SmsMfaConfigType', ], 'SoftwareTokenMfaConfiguration' => [ 'shape' => 'SoftwareTokenMfaConfigType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], ], ], 'SetUserPoolMfaConfigResponse' => [ 'type' => 'structure', 'members' => [ 'SmsMfaConfiguration' => [ 'shape' => 'SmsMfaConfigType', ], 'SoftwareTokenMfaConfiguration' => [ 'shape' => 'SoftwareTokenMfaConfigType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], ], ], 'SetUserSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'MFAOptions', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], ], ], 'SetUserSettingsResponse' => [ 'type' => 'structure', 'members' => [], ], 'SignUpRequest' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'Username', 'Password', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'SecretHash' => [ 'shape' => 'SecretHashType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'Password' => [ 'shape' => 'PasswordType', ], 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'ValidationData' => [ 'shape' => 'AttributeListType', ], 'AnalyticsMetadata' => [ 'shape' => 'AnalyticsMetadataType', ], 'UserContextData' => [ 'shape' => 'UserContextDataType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'SignUpResponse' => [ 'type' => 'structure', 'required' => [ 'UserConfirmed', 'UserSub', ], 'members' => [ 'UserConfirmed' => [ 'shape' => 'BooleanType', ], 'CodeDeliveryDetails' => [ 'shape' => 'CodeDeliveryDetailsType', ], 'UserSub' => [ 'shape' => 'StringType', ], ], ], 'SkippedIPRangeListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringType', ], 'max' => 200, ], 'SmsConfigurationType' => [ 'type' => 'structure', 'required' => [ 'SnsCallerArn', ], 'members' => [ 'SnsCallerArn' => [ 'shape' => 'ArnType', ], 'ExternalId' => [ 'shape' => 'StringType', ], 'SnsRegion' => [ 'shape' => 'RegionCodeType', ], ], ], 'SmsMfaConfigType' => [ 'type' => 'structure', 'members' => [ 'SmsAuthenticationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'SmsConfiguration' => [ 'shape' => 'SmsConfigurationType', ], ], ], 'SmsVerificationMessageType' => [ 'type' => 'string', 'max' => 140, 'min' => 6, 'pattern' => '.*\\{####\\}.*', ], 'SoftwareTokenMFANotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'SoftwareTokenMFAUserCodeType' => [ 'type' => 'string', 'max' => 6, 'min' => 6, 'pattern' => '[0-9]+', ], 'SoftwareTokenMfaConfigType' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'BooleanType', ], ], ], 'SoftwareTokenMfaSettingsType' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'BooleanType', ], 'PreferredMfa' => [ 'shape' => 'BooleanType', ], ], ], 'StartUserImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'JobId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'JobId' => [ 'shape' => 'UserImportJobIdType', ], ], ], 'StartUserImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJob' => [ 'shape' => 'UserImportJobType', ], ], ], 'StatusType' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'StopUserImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'JobId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'JobId' => [ 'shape' => 'UserImportJobIdType', ], ], ], 'StopUserImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'UserImportJob' => [ 'shape' => 'UserImportJobType', ], ], ], 'StringAttributeConstraintsType' => [ 'type' => 'structure', 'members' => [ 'MinLength' => [ 'shape' => 'StringType', ], 'MaxLength' => [ 'shape' => 'StringType', ], ], ], 'StringType' => [ 'type' => 'string', 'max' => 131072, 'min' => 0, ], 'SupportedIdentityProvidersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProviderNameType', ], ], 'TagKeysType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ArnType', ], 'Tags' => [ 'shape' => 'UserPoolTagsType', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValueType' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TemporaryPasswordValidityDaysType' => [ 'type' => 'integer', 'max' => 365, 'min' => 0, ], 'TimeUnitsType' => [ 'type' => 'string', 'enum' => [ 'seconds', 'minutes', 'hours', 'days', ], ], 'TokenModelType' => [ 'type' => 'string', 'pattern' => '[A-Za-z0-9-_=.]+', 'sensitive' => true, ], 'TokenValidityUnitsType' => [ 'type' => 'structure', 'members' => [ 'AccessToken' => [ 'shape' => 'TimeUnitsType', ], 'IdToken' => [ 'shape' => 'TimeUnitsType', ], 'RefreshToken' => [ 'shape' => 'TimeUnitsType', ], ], ], 'TooManyFailedAttemptsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UICustomizationType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ImageUrl' => [ 'shape' => 'ImageUrlType', ], 'CSS' => [ 'shape' => 'CSSType', ], 'CSSVersion' => [ 'shape' => 'CSSVersionType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'UnauthorizedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnexpectedLambdaException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnsupportedIdentityProviderException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnsupportedOperationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnsupportedTokenTypeException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UnsupportedUserStateException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ArnType', ], 'TagKeys' => [ 'shape' => 'UserPoolTagsListType', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAuthEventFeedbackRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Username', 'EventId', 'FeedbackToken', 'FeedbackValue', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Username' => [ 'shape' => 'UsernameType', ], 'EventId' => [ 'shape' => 'EventIdType', ], 'FeedbackToken' => [ 'shape' => 'TokenModelType', ], 'FeedbackValue' => [ 'shape' => 'FeedbackValueType', ], ], ], 'UpdateAuthEventFeedbackResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateDeviceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'DeviceKey', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'DeviceKey' => [ 'shape' => 'DeviceKeyType', ], 'DeviceRememberedStatus' => [ 'shape' => 'DeviceRememberedStatusType', ], ], ], 'UpdateDeviceStatusResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'UserPoolId', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupNameType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Description' => [ 'shape' => 'DescriptionType', ], 'RoleArn' => [ 'shape' => 'ArnType', ], 'Precedence' => [ 'shape' => 'PrecedenceType', ], ], ], 'UpdateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'GroupType', ], ], ], 'UpdateIdentityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ProviderName', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ProviderName' => [ 'shape' => 'ProviderNameType', ], 'ProviderDetails' => [ 'shape' => 'ProviderDetailsType', ], 'AttributeMapping' => [ 'shape' => 'AttributeMappingType', ], 'IdpIdentifiers' => [ 'shape' => 'IdpIdentifiersListType', ], ], ], 'UpdateIdentityProviderResponse' => [ 'type' => 'structure', 'required' => [ 'IdentityProvider', ], 'members' => [ 'IdentityProvider' => [ 'shape' => 'IdentityProviderType', ], ], ], 'UpdateResourceServerRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'Identifier', 'Name', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Identifier' => [ 'shape' => 'ResourceServerIdentifierType', ], 'Name' => [ 'shape' => 'ResourceServerNameType', ], 'Scopes' => [ 'shape' => 'ResourceServerScopeListType', ], ], ], 'UpdateResourceServerResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceServer', ], 'members' => [ 'ResourceServer' => [ 'shape' => 'ResourceServerType', ], ], ], 'UpdateUserAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'UserAttributes', 'AccessToken', ], 'members' => [ 'UserAttributes' => [ 'shape' => 'AttributeListType', ], 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'ClientMetadata' => [ 'shape' => 'ClientMetadataType', ], ], ], 'UpdateUserAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'CodeDeliveryDetailsList' => [ 'shape' => 'CodeDeliveryDetailsListType', ], ], ], 'UpdateUserPoolClientRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', 'ClientId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ClientName' => [ 'shape' => 'ClientNameType', ], 'RefreshTokenValidity' => [ 'shape' => 'RefreshTokenValidityType', ], 'AccessTokenValidity' => [ 'shape' => 'AccessTokenValidityType', ], 'IdTokenValidity' => [ 'shape' => 'IdTokenValidityType', ], 'TokenValidityUnits' => [ 'shape' => 'TokenValidityUnitsType', ], 'ReadAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'WriteAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'ExplicitAuthFlows' => [ 'shape' => 'ExplicitAuthFlowsListType', ], 'SupportedIdentityProviders' => [ 'shape' => 'SupportedIdentityProvidersListType', ], 'CallbackURLs' => [ 'shape' => 'CallbackURLsListType', ], 'LogoutURLs' => [ 'shape' => 'LogoutURLsListType', ], 'DefaultRedirectURI' => [ 'shape' => 'RedirectUrlType', ], 'AllowedOAuthFlows' => [ 'shape' => 'OAuthFlowsType', ], 'AllowedOAuthScopes' => [ 'shape' => 'ScopeListType', ], 'AllowedOAuthFlowsUserPoolClient' => [ 'shape' => 'BooleanType', ], 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfigurationType', ], 'PreventUserExistenceErrors' => [ 'shape' => 'PreventUserExistenceErrorTypes', ], 'EnableTokenRevocation' => [ 'shape' => 'WrappedBooleanType', ], 'EnablePropagateAdditionalUserContextData' => [ 'shape' => 'WrappedBooleanType', ], 'AuthSessionValidity' => [ 'shape' => 'AuthSessionValidityType', ], ], ], 'UpdateUserPoolClientResponse' => [ 'type' => 'structure', 'members' => [ 'UserPoolClient' => [ 'shape' => 'UserPoolClientType', ], ], ], 'UpdateUserPoolDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Domain', 'UserPoolId', 'CustomDomainConfig', ], 'members' => [ 'Domain' => [ 'shape' => 'DomainType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'CustomDomainConfig' => [ 'shape' => 'CustomDomainConfigType', ], ], ], 'UpdateUserPoolDomainResponse' => [ 'type' => 'structure', 'members' => [ 'CloudFrontDomain' => [ 'shape' => 'DomainType', ], ], ], 'UpdateUserPoolRequest' => [ 'type' => 'structure', 'required' => [ 'UserPoolId', ], 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'Policies' => [ 'shape' => 'UserPoolPolicyType', ], 'DeletionProtection' => [ 'shape' => 'DeletionProtectionType', ], 'LambdaConfig' => [ 'shape' => 'LambdaConfigType', ], 'AutoVerifiedAttributes' => [ 'shape' => 'VerifiedAttributesListType', ], 'SmsVerificationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailVerificationMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailVerificationSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], 'VerificationMessageTemplate' => [ 'shape' => 'VerificationMessageTemplateType', ], 'SmsAuthenticationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'UserAttributeUpdateSettings' => [ 'shape' => 'UserAttributeUpdateSettingsType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], 'DeviceConfiguration' => [ 'shape' => 'DeviceConfigurationType', ], 'EmailConfiguration' => [ 'shape' => 'EmailConfigurationType', ], 'SmsConfiguration' => [ 'shape' => 'SmsConfigurationType', ], 'UserPoolTags' => [ 'shape' => 'UserPoolTagsType', ], 'AdminCreateUserConfig' => [ 'shape' => 'AdminCreateUserConfigType', ], 'UserPoolAddOns' => [ 'shape' => 'UserPoolAddOnsType', ], 'AccountRecoverySetting' => [ 'shape' => 'AccountRecoverySettingType', ], ], ], 'UpdateUserPoolResponse' => [ 'type' => 'structure', 'members' => [], ], 'UserAttributeUpdateSettingsType' => [ 'type' => 'structure', 'members' => [ 'AttributesRequireVerificationBeforeUpdate' => [ 'shape' => 'AttributesRequireVerificationBeforeUpdateType', ], ], ], 'UserContextDataType' => [ 'type' => 'structure', 'members' => [ 'IpAddress' => [ 'shape' => 'StringType', ], 'EncodedData' => [ 'shape' => 'StringType', ], ], ], 'UserFilterType' => [ 'type' => 'string', 'max' => 256, ], 'UserImportInProgressException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserImportJobIdType' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => 'import-[0-9a-zA-Z-]+', ], 'UserImportJobNameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w\\s+=,.@-]+', ], 'UserImportJobStatusType' => [ 'type' => 'string', 'enum' => [ 'Created', 'Pending', 'InProgress', 'Stopping', 'Expired', 'Stopped', 'Failed', 'Succeeded', ], ], 'UserImportJobType' => [ 'type' => 'structure', 'members' => [ 'JobName' => [ 'shape' => 'UserImportJobNameType', ], 'JobId' => [ 'shape' => 'UserImportJobIdType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'PreSignedUrl' => [ 'shape' => 'PreSignedUrlType', ], 'CreationDate' => [ 'shape' => 'DateType', ], 'StartDate' => [ 'shape' => 'DateType', ], 'CompletionDate' => [ 'shape' => 'DateType', ], 'Status' => [ 'shape' => 'UserImportJobStatusType', ], 'CloudWatchLogsRoleArn' => [ 'shape' => 'ArnType', ], 'ImportedUsers' => [ 'shape' => 'LongType', ], 'SkippedUsers' => [ 'shape' => 'LongType', ], 'FailedUsers' => [ 'shape' => 'LongType', ], 'CompletionMessage' => [ 'shape' => 'CompletionMessageType', ], ], ], 'UserImportJobsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserImportJobType', ], 'max' => 50, 'min' => 1, ], 'UserLambdaValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserMFASettingListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringType', ], ], 'UserNotConfirmedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserPoolAddOnNotEnabledException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserPoolAddOnsType' => [ 'type' => 'structure', 'required' => [ 'AdvancedSecurityMode', ], 'members' => [ 'AdvancedSecurityMode' => [ 'shape' => 'AdvancedSecurityModeType', ], ], ], 'UserPoolClientDescription' => [ 'type' => 'structure', 'members' => [ 'ClientId' => [ 'shape' => 'ClientIdType', ], 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientName' => [ 'shape' => 'ClientNameType', ], ], ], 'UserPoolClientListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserPoolClientDescription', ], ], 'UserPoolClientType' => [ 'type' => 'structure', 'members' => [ 'UserPoolId' => [ 'shape' => 'UserPoolIdType', ], 'ClientName' => [ 'shape' => 'ClientNameType', ], 'ClientId' => [ 'shape' => 'ClientIdType', ], 'ClientSecret' => [ 'shape' => 'ClientSecretType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], 'RefreshTokenValidity' => [ 'shape' => 'RefreshTokenValidityType', ], 'AccessTokenValidity' => [ 'shape' => 'AccessTokenValidityType', ], 'IdTokenValidity' => [ 'shape' => 'IdTokenValidityType', ], 'TokenValidityUnits' => [ 'shape' => 'TokenValidityUnitsType', ], 'ReadAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'WriteAttributes' => [ 'shape' => 'ClientPermissionListType', ], 'ExplicitAuthFlows' => [ 'shape' => 'ExplicitAuthFlowsListType', ], 'SupportedIdentityProviders' => [ 'shape' => 'SupportedIdentityProvidersListType', ], 'CallbackURLs' => [ 'shape' => 'CallbackURLsListType', ], 'LogoutURLs' => [ 'shape' => 'LogoutURLsListType', ], 'DefaultRedirectURI' => [ 'shape' => 'RedirectUrlType', ], 'AllowedOAuthFlows' => [ 'shape' => 'OAuthFlowsType', ], 'AllowedOAuthScopes' => [ 'shape' => 'ScopeListType', ], 'AllowedOAuthFlowsUserPoolClient' => [ 'shape' => 'BooleanType', 'box' => true, ], 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfigurationType', ], 'PreventUserExistenceErrors' => [ 'shape' => 'PreventUserExistenceErrorTypes', ], 'EnableTokenRevocation' => [ 'shape' => 'WrappedBooleanType', ], 'EnablePropagateAdditionalUserContextData' => [ 'shape' => 'WrappedBooleanType', ], 'AuthSessionValidity' => [ 'shape' => 'AuthSessionValidityType', ], ], ], 'UserPoolDescriptionType' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserPoolIdType', ], 'Name' => [ 'shape' => 'UserPoolNameType', ], 'LambdaConfig' => [ 'shape' => 'LambdaConfigType', ], 'Status' => [ 'shape' => 'StatusType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], ], ], 'UserPoolIdType' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'UserPoolListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserPoolDescriptionType', ], ], 'UserPoolMfaType' => [ 'type' => 'string', 'enum' => [ 'OFF', 'ON', 'OPTIONAL', ], ], 'UserPoolNameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\w\\s+=,.@-]+', ], 'UserPoolPolicyType' => [ 'type' => 'structure', 'members' => [ 'PasswordPolicy' => [ 'shape' => 'PasswordPolicyType', ], ], ], 'UserPoolTaggingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UserPoolTagsListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKeysType', ], ], 'UserPoolTagsType' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKeysType', ], 'value' => [ 'shape' => 'TagValueType', ], ], 'UserPoolType' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserPoolIdType', ], 'Name' => [ 'shape' => 'UserPoolNameType', ], 'Policies' => [ 'shape' => 'UserPoolPolicyType', ], 'DeletionProtection' => [ 'shape' => 'DeletionProtectionType', ], 'LambdaConfig' => [ 'shape' => 'LambdaConfigType', ], 'Status' => [ 'shape' => 'StatusType', ], 'LastModifiedDate' => [ 'shape' => 'DateType', ], 'CreationDate' => [ 'shape' => 'DateType', ], 'SchemaAttributes' => [ 'shape' => 'SchemaAttributesListType', ], 'AutoVerifiedAttributes' => [ 'shape' => 'VerifiedAttributesListType', ], 'AliasAttributes' => [ 'shape' => 'AliasAttributesListType', ], 'UsernameAttributes' => [ 'shape' => 'UsernameAttributesListType', ], 'SmsVerificationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailVerificationMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailVerificationSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], 'VerificationMessageTemplate' => [ 'shape' => 'VerificationMessageTemplateType', ], 'SmsAuthenticationMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'UserAttributeUpdateSettings' => [ 'shape' => 'UserAttributeUpdateSettingsType', ], 'MfaConfiguration' => [ 'shape' => 'UserPoolMfaType', ], 'DeviceConfiguration' => [ 'shape' => 'DeviceConfigurationType', ], 'EstimatedNumberOfUsers' => [ 'shape' => 'IntegerType', ], 'EmailConfiguration' => [ 'shape' => 'EmailConfigurationType', ], 'SmsConfiguration' => [ 'shape' => 'SmsConfigurationType', ], 'UserPoolTags' => [ 'shape' => 'UserPoolTagsType', ], 'SmsConfigurationFailure' => [ 'shape' => 'StringType', ], 'EmailConfigurationFailure' => [ 'shape' => 'StringType', ], 'Domain' => [ 'shape' => 'DomainType', ], 'CustomDomain' => [ 'shape' => 'DomainType', ], 'AdminCreateUserConfig' => [ 'shape' => 'AdminCreateUserConfigType', ], 'UserPoolAddOns' => [ 'shape' => 'UserPoolAddOnsType', ], 'UsernameConfiguration' => [ 'shape' => 'UsernameConfigurationType', ], 'Arn' => [ 'shape' => 'ArnType', ], 'AccountRecoverySetting' => [ 'shape' => 'AccountRecoverySettingType', ], ], ], 'UserStatusType' => [ 'type' => 'string', 'enum' => [ 'UNCONFIRMED', 'CONFIRMED', 'ARCHIVED', 'COMPROMISED', 'UNKNOWN', 'RESET_REQUIRED', 'FORCE_CHANGE_PASSWORD', ], ], 'UserType' => [ 'type' => 'structure', 'members' => [ 'Username' => [ 'shape' => 'UsernameType', ], 'Attributes' => [ 'shape' => 'AttributeListType', ], 'UserCreateDate' => [ 'shape' => 'DateType', ], 'UserLastModifiedDate' => [ 'shape' => 'DateType', ], 'Enabled' => [ 'shape' => 'BooleanType', ], 'UserStatus' => [ 'shape' => 'UserStatusType', ], 'MFAOptions' => [ 'shape' => 'MFAOptionListType', ], ], ], 'UsernameAttributeType' => [ 'type' => 'string', 'enum' => [ 'phone_number', 'email', ], ], 'UsernameAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UsernameAttributeType', ], ], 'UsernameConfigurationType' => [ 'type' => 'structure', 'required' => [ 'CaseSensitive', ], 'members' => [ 'CaseSensitive' => [ 'shape' => 'WrappedBooleanType', ], ], ], 'UsernameExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'MessageType', ], ], 'exception' => true, ], 'UsernameType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', 'sensitive' => true, ], 'UsersListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserType', ], ], 'VerificationMessageTemplateType' => [ 'type' => 'structure', 'members' => [ 'SmsMessage' => [ 'shape' => 'SmsVerificationMessageType', ], 'EmailMessage' => [ 'shape' => 'EmailVerificationMessageType', ], 'EmailSubject' => [ 'shape' => 'EmailVerificationSubjectType', ], 'EmailMessageByLink' => [ 'shape' => 'EmailVerificationMessageByLinkType', ], 'EmailSubjectByLink' => [ 'shape' => 'EmailVerificationSubjectByLinkType', ], 'DefaultEmailOption' => [ 'shape' => 'DefaultEmailOptionType', ], ], ], 'VerifiedAttributeType' => [ 'type' => 'string', 'enum' => [ 'phone_number', 'email', ], ], 'VerifiedAttributesListType' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedAttributeType', ], ], 'VerifySoftwareTokenRequest' => [ 'type' => 'structure', 'required' => [ 'UserCode', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'Session' => [ 'shape' => 'SessionType', ], 'UserCode' => [ 'shape' => 'SoftwareTokenMFAUserCodeType', ], 'FriendlyDeviceName' => [ 'shape' => 'StringType', ], ], ], 'VerifySoftwareTokenResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'VerifySoftwareTokenResponseType', ], 'Session' => [ 'shape' => 'SessionType', ], ], ], 'VerifySoftwareTokenResponseType' => [ 'type' => 'string', 'enum' => [ 'SUCCESS', 'ERROR', ], ], 'VerifyUserAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'AccessToken', 'AttributeName', 'Code', ], 'members' => [ 'AccessToken' => [ 'shape' => 'TokenModelType', ], 'AttributeName' => [ 'shape' => 'AttributeNameType', ], 'Code' => [ 'shape' => 'ConfirmationCodeType', ], ], ], 'VerifyUserAttributeResponse' => [ 'type' => 'structure', 'members' => [], ], 'WrappedBooleanType' => [ 'type' => 'boolean', ], ],]; diff --git a/src/data/cognito-idp/2016-04-18/docs-2.json b/src/data/cognito-idp/2016-04-18/docs-2.json index a9191f9a2e..29927ff2f3 100644 --- a/src/data/cognito-idp/2016-04-18/docs-2.json +++ b/src/data/cognito-idp/2016-04-18/docs-2.json @@ -1,51 +1,51 @@ { "version": "2.0", - "service": "Using the Amazon Cognito user pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito user pools.
For more information, see the Amazon Cognito Documentation.
", + "service": "With the Amazon Cognito user pools API, you can set up user pools and app clients, and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can link IdP users to native user profiles. Learn more about the authentication and authorization of federated users in the Using the Amazon Cognito user pools API and user pool endpoints.
This API reference provides detailed information about API operations and object types in Amazon Cognito. At the bottom of the page for each API operation and object, under See Also, you can learn how to use it in an Amazon Web Services SDK in the language of your choice.
Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side user operations. For more information, see Using the Amazon Cognito native and OIDC APIs in the Amazon Cognito Developer Guide.
You can also start reading about the CognitoIdentityProvider client in the following SDK guides.
To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.
", "operations": { - "AddCustomAttributes": "Adds additional user attributes to the user pool schema.
", - "AdminAddUserToGroup": "Adds the specified user to the specified group.
Calling this action requires developer credentials.
", - "AdminConfirmSignUp": "Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action requires developer credentials.
", - "AdminCreateUser": "Creates a new user in the specified user pool.
If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.
AdminCreateUser requires developer credentials.
Deletes a user as an administrator. Works on any user.
Calling this action requires developer credentials.
", - "AdminDeleteUserAttributes": "Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
", - "AdminDisableProviderForUser": "Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser.
This action is enabled only for admin access and requires developer credentials.
The ProviderName must match the value specified when creating an IdP for the pool.
To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user.
The ProviderAttributeName must always be Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to GetUser and ListUsers API requests.
You must make this API request with Amazon Web Services credentials that have cognito-idp:AdminDisableUser permissions.
Enables the specified user as an administrator. Works on any user.
Calling this action requires developer credentials.
", - "AdminForgetDevice": "Forgets the device, as an administrator.
Calling this action requires developer credentials.
", - "AdminGetDevice": "Gets the device, as an administrator.
Calling this action requires developer credentials.
", - "AdminGetUser": "Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
", - "AdminInitiateAuth": "Initiates the authentication flow, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
", - "AdminLinkProviderForUser": "Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account.
The maximum number of federated identities linked to a user is five.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner.
This action is administrative and requires developer credentials.
", - "AdminListDevices": "Lists devices, as an administrator.
Calling this action requires developer credentials.
", - "AdminListGroupsForUser": "Lists the groups that the user belongs to.
Calling this action requires developer credentials.
", - "AdminListUserAuthEvents": "A history of user activity and any risks detected as part of Amazon Cognito advanced security.
", - "AdminRemoveUserFromGroup": "Removes the specified user from the specified group.
Calling this action requires developer credentials.
", - "AdminResetUserPassword": "Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
", - "AdminRespondToAuthChallenge": "Responds to an authentication challenge, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
", - "AdminSetUserMFAPreference": "The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
", - "AdminSetUserPassword": "Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password.
Once the user has set a new password, or the password is permanent, the user status is set to Confirmed.
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
", - "AdminUpdateAuthEventFeedback": "Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
", - "AdminUpdateDeviceStatus": "Updates the device status as an administrator.
Calling this action requires developer credentials.
", - "AdminUpdateUserAttributes": "Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
", - "AdminUserGlobalSignOut": "Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.
Calling this action requires developer credentials.
", - "AssociateSoftwareToken": "Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP.
Changes the password for a specified user in a user pool.
", - "ConfirmDevice": "Confirms tracking of the device. This API call is the call that begins device tracking.
", - "ConfirmForgotPassword": "Allows a user to enter a confirmation code to reset a forgotten password.
", - "ConfirmSignUp": "Confirms registration of a new user.
", - "CreateGroup": "Creates a new group in the specified user pool.
Calling this action requires developer credentials.
", - "CreateIdentityProvider": "Creates an IdP for a user pool.
", - "CreateResourceServer": "Creates a new OAuth2.0 resource server and defines custom scopes within it.
", - "CreateUserImportJob": "Creates the user import job.
", - "CreateUserPool": "Creates a new Amazon Cognito user pool and sets the password policy for the pool.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
", - "CreateUserPoolDomain": "Creates a new domain for a user pool.
", + "AddCustomAttributes": "Adds additional user attributes to the user pool schema.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Adds the specified user to the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Confirms user registration as an admin without using a confirmation code. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates a new user in the specified user pool.
If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Deletes a user as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Deletes the user attributes in a user pool as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser.
The ProviderName must match the value specified when creating an IdP for the pool.
To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user.
The ProviderAttributeName must always be Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to GetUser and ListUsers API requests.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Enables the specified user as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Forgets the device, as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Gets the device, as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Initiates the authentication flow, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account.
The maximum number of federated identities linked to a user is five.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists devices, as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the groups that the user belongs to.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Removes the specified user from the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Resets the specified user's password in a user pool as an administrator. Works on any user.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Deactivates a user's password, requiring them to change it. If a user tries to sign in after the API is called, Amazon Cognito responds with a PasswordResetRequiredException error. Your app must then perform the actions that reset your user's password: the forgot-password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Responds to an authentication challenge, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password.
Once the user has set a new password, or the password is permanent, the user status is set to Confirmed.
AdminSetUserPassword can set a password for the user profile that Amazon Cognito creates for third-party federated users. When you set a password, the federated user's status changes from EXTERNAL_PROVIDER to CONFIRMED. A user in this state can sign in as a federated user, and initiate authentication flows in the API like a linked native user. They can also modify their password and attributes in token-authenticated API requests like ChangePassword and UpdateUserAttributes. As a best security practice and to keep users in sync with your external IdP, don't set passwords on federated user profiles. To set up a federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user profile.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates the device status as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Signs out a user from all devices. AdminUserGlobalSignOut invalidates all identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.
Your app isn't aware that a user's access token is revoked unless it attempts to authorize a user pools API request with an access token that contains the scope aws.cognito.signin.user.admin. Your app might otherwise accept access tokens until they expire.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Changes the password for a specified user in a user pool.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Confirms tracking of the device. This API call is the call that begins device tracking.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Allows a user to enter a confirmation code to reset a forgotten password.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Confirms registration of a new user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Creates a new group in the specified user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates an IdP for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates a new OAuth2.0 resource server and defines custom scopes within it.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates a user import job.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates a new domain for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Deletes a group.
Calling this action requires developer credentials.
", "DeleteIdentityProvider": "Deletes an IdP for a user pool.
", "DeleteResourceServer": "Deletes a resource server.
", - "DeleteUser": "Allows a user to delete himself or herself.
", - "DeleteUserAttributes": "Deletes the attributes for a user.
", + "DeleteUser": "Allows a user to delete their own user profile.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Deletes the attributes for a user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Deletes the specified Amazon Cognito user pool.
", "DeleteUserPoolClient": "Allows the developer to delete the user pool client.
", "DeleteUserPoolDomain": "Deletes a domain for a user pool.
", @@ -53,56 +53,58 @@ "DescribeResourceServer": "Describes a resource server.
", "DescribeRiskConfiguration": "Describes the risk configuration.
", "DescribeUserImportJob": "Describes the user import job.
", - "DescribeUserPool": "Returns the configuration information and metadata of the specified user pool.
", - "DescribeUserPoolClient": "Client method for returning the configuration information and metadata of the specified user pool app client.
", + "DescribeUserPool": "Returns the configuration information and metadata of the specified user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Client method for returning the configuration information and metadata of the specified user pool app client.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Gets information about a domain.
", - "ForgetDevice": "Forgets the specified device.
", - "ForgotPassword": "Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Forgets the specified device.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
If neither a verified phone number nor a verified email exists, this API returns InvalidParameterException. If your app client has a client secret and you don't provide a SECRET_HASH parameter, this API returns NotAuthorizedException.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
", - "GetDevice": "Gets the device.
", + "GetDevice": "Gets the device.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Gets a group.
Calling this action requires developer credentials.
", "GetIdentityProviderByIdentifier": "Gets the specified IdP.
", + "GetLogDeliveryConfiguration": "Gets the detailed activity logging configuration for a user pool.
", "GetSigningCertificate": "This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.
Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to GetSigningCertificate, but doesn't invalidate the original certificate.
Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app clientId is ALL), then that information is returned. If nothing is present, then an empty shape is returned.
Gets the user attributes and metadata for a user.
", - "GetUserAttributeVerificationCode": "Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Gets the user attributes and metadata for a user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Gets the user pool multi-factor authentication (MFA) configuration.
", - "GlobalSignOut": "Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.
", - "InitiateAuth": "Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Lists the sign-in devices that Amazon Cognito has registered to the current user.
", - "ListGroups": "Lists the groups associated with a user pool.
Calling this action requires developer credentials.
", - "ListIdentityProviders": "Lists information about all IdPs for a user pool.
", - "ListResourceServers": "Lists the resource servers for a user pool.
", + "GlobalSignOut": "Signs out a user from all devices. GlobalSignOut invalidates all identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.
Your app isn't aware that a user's access token is revoked unless it attempts to authorize a user pools API request with an access token that contains the scope aws.cognito.signin.user.admin. Your app might otherwise accept access tokens until they expire.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Lists the sign-in devices that Amazon Cognito has registered to the current user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Lists the groups associated with a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists information about all IdPs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the resource servers for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
", - "ListUserImportJobs": "Lists the user import jobs.
", - "ListUserPoolClients": "Lists the clients that have been created for the specified user pool.
", - "ListUserPools": "Lists the user pools associated with an Amazon Web Services account.
", - "ListUsers": "Lists the users in the Amazon Cognito user pool.
", - "ListUsersInGroup": "Lists the users in the specified group.
Calling this action requires developer credentials.
", - "ResendConfirmationCode": "Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Responds to the authentication challenge.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.
", + "ListUserImportJobs": "Lists user import jobs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the clients that have been created for the specified user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the user pools associated with an Amazon Web Services account.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists users and their basic details in a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the users in the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Responds to the authentication challenge.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Sets up or modifies the detailed activity logging configuration of a user pool.
", "SetRiskConfiguration": "Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.
To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
Sets the user interface (UI) customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
", - "SetUserPoolMfaConfig": "Sets the user pool multi-factor authentication (MFA) configuration.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
", - "SignUp": "Registers the user in the specified user pool and creates a user name, password, and user attributes.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Sets the user pool multi-factor authentication (MFA) configuration.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Registers the user in the specified user pool and creates a user name, password, and user attributes.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Starts the user import.
", "StopUserImportJob": "Stops the user import job.
", "TagResource": "Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool, and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
", "UntagResource": "Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.
", - "UpdateAuthEventFeedback": "Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
", - "UpdateDeviceStatus": "Updates the device status.
", - "UpdateGroup": "Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
", - "UpdateIdentityProvider": "Updates IdP information for a user pool.
", - "UpdateResourceServer": "Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it is set to the default value.
Allows a user to update a specific attribute (one at a time).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don't provide a value for an attribute, it will be set to the default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
", - "UpdateUserPoolDomain": "Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
", - "VerifySoftwareToken": "Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as \"verified\" if successful. The request takes an access token or a session string, but not both.
", - "VerifyUserAttribute": "Verifies the specified user attributes in the user pool.
If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
" + "UpdateAuthEventFeedback": "Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Updates the device status.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Updates the specified group with the specified attributes.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates IdP information for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it is set to the default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Allows a user to update a specific attribute (one at a time).
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as \"verified\" if successful. The request takes an access token or a session string, but not both.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Verifies the specified user attributes in the user pool.
If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Represents the request to confirm user registration.
", + "base": "Confirm a user's registration as a user pool administrator.
", "refs": { } }, @@ -427,7 +429,7 @@ "AdvancedSecurityModeType": { "base": null, "refs": { - "UserPoolAddOnsType$AdvancedSecurityMode": "The advanced security mode.
" + "UserPoolAddOnsType$AdvancedSecurityMode": "The operating mode of advanced security features in your user pool.
" } }, "AliasAttributeType": { @@ -449,7 +451,7 @@ } }, "AnalyticsConfigurationType": { - "base": "The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
In Regions where Amazon Pinpointisn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
In Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
", "AnalyticsConfigurationType$RoleArn": "The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
", + "CloudWatchLogsConfigurationType$LogGroupArn": "The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs. The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account as your user pool.
", "CreateGroupRequest$RoleArn": "The role Amazon Resource Name (ARN) for the group.
", "CreateUserImportJobRequest$CloudWatchLogsRoleArn": "The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
", "CustomDomainConfigType$CertificateArn": "The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
", "CustomEmailLambdaVersionConfigType$LambdaArn": "The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.
", "CustomSMSLambdaVersionConfigType$LambdaArn": "The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.
", - "EmailConfigurationType$SourceArn": "The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.
The ARN of a verified email address or an address from a verified domain in Amazon SES. You can set a SourceArn email from a verified domain only with an API request. You can set a verified email address, but not an address in a verified domain, in the Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.
The role Amazon Resource Name (ARN) for the group.
", "LambdaConfigType$PreSignUp": "A pre-registration Lambda trigger.
", "LambdaConfigType$CustomMessage": "A custom Message Lambda trigger.
", @@ -516,7 +519,7 @@ "AttributeDataType": { "base": null, "refs": { - "SchemaAttributeType$AttributeDataType": "The attribute data type.
" + "SchemaAttributeType$AttributeDataType": "The data format of the values for your attribute.
" } }, "AttributeListType": { @@ -582,7 +585,7 @@ "AttributesRequireVerificationBeforeUpdateType": { "base": null, "refs": { - "UserAttributeUpdateSettingsType$AttributesRequireVerificationBeforeUpdate": "Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.
You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.
When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.
Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.
You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.
When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.
The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For ADMIN_USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
True if the password is permanent, False if it is temporary.
If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
Indicates whether the user confirmation must confirm the device response.
", - "CreateUserPoolClientRequest$AllowedOAuthFlowsUserPoolClient": "Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
", + "CreateUserPoolClientRequest$AllowedOAuthFlowsUserPoolClient": "Set to true to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false.
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.
In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
", @@ -652,14 +655,14 @@ "SMSMfaSettingsType$Enabled": "Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.
", "SMSMfaSettingsType$PreferredMfa": "Specifies whether SMS is the preferred MFA method.
", "SchemaAttributeType$DeveloperOnlyAttribute": "You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.
Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.
Specifies whether the value of the attribute can be changed.
For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
Specifies whether the value of the attribute can be changed.
Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.
", "SignUpResponse$UserConfirmed": "A response from the server indicating that a user registration has been confirmed.
", "SoftwareTokenMfaConfigType$Enabled": "Specifies whether software token MFA is activated.
", "SoftwareTokenMfaSettingsType$Enabled": "Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.
", "SoftwareTokenMfaSettingsType$PreferredMfa": "Specifies whether software token MFA is the preferred MFA method.
", - "UpdateUserPoolClientRequest$AllowedOAuthFlowsUserPoolClient": "Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
", - "UserPoolClientType$AllowedOAuthFlowsUserPoolClient": "Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
", + "UpdateUserPoolClientRequest$AllowedOAuthFlowsUserPoolClient": "Set to true to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false.
Set to true to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false.
Specifies whether the user is enabled.
" } }, @@ -731,8 +734,8 @@ "ChallengeResponsesType": { "base": null, "refs": { - "AdminRespondToAuthChallengeRequest$ChallengeResponses": "The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
The value of the USERNAME attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).
SMS_MFA: SMS_MFA_CODE, USERNAME.
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.
PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
The value of the USERNAME attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).
SMS_MFA: SMS_MFA_CODE, USERNAME.
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.
PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
The client secret from the user pool request of the client type.
" } }, + "CloudWatchLogsConfigurationType": { + "base": "The CloudWatch logging destination of a user pool detailed activity logging configuration.
", + "refs": { + "LogConfigurationType$CloudWatchLogsConfiguration": "The CloudWatch logging destination of a user pool.
" + } + }, "CodeDeliveryDetailsListType": { "base": null, "refs": { @@ -998,7 +1007,7 @@ "CustomAttributeNameType": { "base": null, "refs": { - "SchemaAttributeType$Name": "A schema attribute of the name type.
" + "SchemaAttributeType$Name": "The name of your user pool attribute, for example username or custom:costcenter.
The date the user was created.
", - "AdminGetUserResponse$UserLastModifiedDate": "The date the user was last modified.
", - "AuthEventType$CreationDate": "The creation date
", + "AdminGetUserResponse$UserLastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
", + "AuthEventType$CreationDate": "The date and time, in ISO 8601 format, when the item was created.
", "DeviceType$DeviceCreateDate": "The creation date of the device.
", - "DeviceType$DeviceLastModifiedDate": "The last modified date of the device.
", + "DeviceType$DeviceLastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
", "DeviceType$DeviceLastAuthenticatedDate": "The date when the device was last authenticated.
", "EventFeedbackType$FeedbackDate": "The event feedback date.
", - "GroupType$LastModifiedDate": "The date the group was last modified.
", - "GroupType$CreationDate": "The date the group was created.
", - "IdentityProviderType$LastModifiedDate": "The date the IdP was last modified.
", - "IdentityProviderType$CreationDate": "The date the IdP was created.
", + "GroupType$LastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
", + "GroupType$CreationDate": "The date and time, in ISO 8601 format, when the item was created.
", + "IdentityProviderType$LastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
", + "IdentityProviderType$CreationDate": "The date and time, in ISO 8601 format, when the item was created.
", "ProviderDescription$LastModifiedDate": "The date the provider was last modified.
", - "ProviderDescription$CreationDate": "The date the provider was added to the user pool.
", - "RiskConfigurationType$LastModifiedDate": "The last modified date.
", - "UICustomizationType$LastModifiedDate": "The last-modified date for the UI customization.
", - "UICustomizationType$CreationDate": "The creation date for the UI customization.
", - "UserImportJobType$CreationDate": "The date the user import job was created.
", + "ProviderDescription$CreationDate": "The date and time, in ISO 8601 format, when the item was created.
", + "RiskConfigurationType$LastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
", + "UICustomizationType$LastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
", + "UICustomizationType$CreationDate": "The date and time, in ISO 8601 format, when the item was created.
", + "UserImportJobType$CreationDate": "The date and time, in ISO 8601 format, when the item was created.
", "UserImportJobType$StartDate": "The date when the user import job was started.
", "UserImportJobType$CompletionDate": "The date when the user import job was completed.
", - "UserPoolClientType$LastModifiedDate": "The date the user pool client was last modified.
", - "UserPoolClientType$CreationDate": "The date the user pool client was created.
", - "UserPoolDescriptionType$LastModifiedDate": "The date the user pool description was last modified.
", - "UserPoolDescriptionType$CreationDate": "The date the user pool description was created.
", - "UserPoolType$LastModifiedDate": "The date the user pool was last modified.
", - "UserPoolType$CreationDate": "The date the user pool was created.
", + "UserPoolClientType$LastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
", + "UserPoolClientType$CreationDate": "The date and time, in ISO 8601 format, when the item was created.
", + "UserPoolDescriptionType$LastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
", + "UserPoolDescriptionType$CreationDate": "The date and time, in ISO 8601 format, when the item was created.
", + "UserPoolType$LastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
", + "UserPoolType$CreationDate": "The date and time, in ISO 8601 format, when the item was created.
", "UserType$UserCreateDate": "The creation date of the user.
", - "UserType$UserLastModifiedDate": "The last modified date of the user.
" + "UserType$UserLastModifiedDate": "The date and time, in ISO 8601 format, when the item was modified.
" } }, "DefaultEmailOptionType": { @@ -1331,7 +1340,7 @@ "refs": { "CreateUserPoolRequest$EmailConfiguration": "The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
", "UpdateUserPoolRequest$EmailConfiguration": "The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
", - "UserPoolType$EmailConfiguration": "The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user pool.
" + "UserPoolType$EmailConfiguration": "The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
" } }, "EmailNotificationBodyType": { @@ -1433,6 +1442,12 @@ "AuthEventType$EventRisk": "The event risk.
" } }, + "EventSourceName": { + "base": null, + "refs": { + "LogConfigurationType$EventSource": "The source of events that your user pool sends for detailed activity logging.
" + } + }, "EventType": { "base": null, "refs": { @@ -1461,9 +1476,9 @@ "FeedbackValueType": { "base": null, "refs": { - "AdminUpdateAuthEventFeedbackRequest$FeedbackValue": "The authentication event feedback value.
", - "EventFeedbackType$FeedbackValue": "The event feedback value.
", - "UpdateAuthEventFeedbackRequest$FeedbackValue": "The authentication event feedback value.
" + "AdminUpdateAuthEventFeedbackRequest$FeedbackValue": "The authentication event feedback value. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.
The authentication event feedback value. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.
The authentication event feedback value. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.
Request to get a signing certificate from Amazon Cognito.
", "refs": { @@ -1654,9 +1679,9 @@ "IdTokenValidityType": { "base": null, "refs": { - "CreateUserPoolClientRequest$IdTokenValidity": "The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
", - "UpdateUserPoolClientRequest$IdTokenValidity": "The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
", - "UserPoolClientType$IdTokenValidity": "The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
" + "CreateUserPoolClientRequest$IdTokenValidity": "The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
", + "UpdateUserPoolClientRequest$IdTokenValidity": "The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
", + "UserPoolClientType$IdTokenValidity": "The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
" } }, "IdentityProviderType": { @@ -1897,6 +1922,32 @@ "refs": { } }, + "LogConfigurationListType": { + "base": null, + "refs": { + "LogDeliveryConfigurationType$LogConfigurations": "The detailed activity logging destination of a user pool.
", + "SetLogDeliveryConfigurationRequest$LogConfigurations": "A collection of all of the detailed activity logging configurations for a user pool.
" + } + }, + "LogConfigurationType": { + "base": "The logging parameters of a user pool.
", + "refs": { + "LogConfigurationListType$member": null + } + }, + "LogDeliveryConfigurationType": { + "base": "The logging parameters of a user pool.
", + "refs": { + "GetLogDeliveryConfigurationResponse$LogDeliveryConfiguration": "The detailed activity logging configuration of the requested user pool.
", + "SetLogDeliveryConfigurationResponse$LogDeliveryConfiguration": "The detailed activity logging configuration that you applied to the requested user pool.
" + } + }, + "LogLevel": { + "base": null, + "refs": { + "LogConfigurationType$LogLevel": "The errorlevel selection of logs that a user pool sends for detailed activity logging.
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify RESEND for the MessageAction parameter.
The password for the user.
", "ChangePasswordRequest$PreviousPassword": "The old password.
", "ChangePasswordRequest$ProposedPassword": "The new password.
", @@ -2169,8 +2220,8 @@ "base": "A container for information about an IdP for a user pool.
", "refs": { "AdminDisableProviderForUserRequest$User": "The user to be disabled.
", - "AdminLinkProviderForUserRequest$DestinationUser": "The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.
For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.
The ProviderAttributeName of the DestinationUser is ignored.
The ProviderName should be set to Cognito for users in Cognito user pools.
All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.
An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
If the SourceUser is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social IdP token.
For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.
The existing user in the user pool that you want to assign to the external IdP user account. This user can be a local (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.
For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.
The ProviderAttributeName of the DestinationUser is ignored.
The ProviderName should be set to Cognito for users in Cognito user pools.
All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.
An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
If the SourceUser is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social IdP token.
For OIDC, the ProviderAttributeName can be any value that matches a claim in the ID token, or that your app retrieves from the userInfo endpoint. You must map the claim to a user pool attribute in your IdP configuration, and set the user pool attribute name as the value of ProviderAttributeName in your AdminLinkProviderForUser request.
For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. To link SAML users based on the subject of the SAML assertion, map the subject to a claim through the SAML IdP and set that claim name as the value of ProviderAttributeName in your AdminLinkProviderForUser request.
For both OIDC and SAML users, when you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the IdP token.
Contains information about the schema attribute.
", + "base": "A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
", "refs": { "CustomAttributesListType$member": null, "SchemaAttributesListType$member": null @@ -2389,7 +2440,7 @@ "base": null, "refs": { "CreateUserPoolRequest$Schema": "An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
", - "UserPoolType$SchemaAttributes": "A container with the schema attributes of a user pool.
" + "UserPoolType$SchemaAttributes": "A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
" } }, "ScopeDoesNotExistException": { @@ -2425,7 +2476,7 @@ "SearchedAttributeNamesListType": { "base": null, "refs": { - "ListUsersRequest$AttributesToGet": "An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
" + "ListUsersRequest$AttributesToGet": "A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to include in the response for each user. When you don't provide an AttributesToGet parameter, Amazon Cognito returns all attributes for each user.
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
", + "ConfirmForgotPasswordRequest$SecretHash": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about SecretHash, see Computing secret hash values.
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
", "ForgotPasswordRequest$SecretHash": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
", "ResendConfirmationCodeRequest$SecretHash": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
", @@ -2459,6 +2510,16 @@ "VerifySoftwareTokenResponse$Session": "The session that should be passed both ways in challenge-response calls to the service.
" } }, + "SetLogDeliveryConfigurationRequest": { + "base": null, + "refs": { + } + }, + "SetLogDeliveryConfigurationResponse": { + "base": null, + "refs": { + } + }, "SetRiskConfigurationRequest": { "base": null, "refs": { @@ -2642,7 +2703,7 @@ "ContextDataType$EncodedData": "Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
", "DeviceSecretVerifierConfigType$PasswordVerifier": "The password verifier.
", "DeviceSecretVerifierConfigType$Salt": "The salt
", - "DomainDescriptionType$CloudFrontDistribution": "The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
", + "DomainDescriptionType$CloudFrontDistribution": "The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
", "EmailConfigurationType$From": "Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.
The source IP address of your user's device.
", "EventContextDataType$DeviceName": "The user's device name.
", @@ -2672,7 +2733,7 @@ "UserContextDataType$IpAddress": "The source IP address of your user's device.
", "UserContextDataType$EncodedData": "Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
", "UserMFASettingListType$member": null, - "UserPoolType$SmsConfigurationFailure": "The reason why the SMS configuration can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
The reason why the SMS configuration can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.
The friendly device name.
" } @@ -2717,9 +2778,9 @@ "TimeUnitsType": { "base": null, "refs": { - "TokenValidityUnitsType$AccessToken": " A time unit of seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours.
A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours.
A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days.
A time unit of seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours. AccessTokenValidity duration can range from five minutes to one day.
A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours. IdTokenValidity duration can range from five minutes to one day.
A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days. RefreshTokenValidity duration can range from 60 minutes to 10 years.
The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.
", "refs": { "CreateUserPoolClientRequest$TokenValidityUnits": "The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
", - "UpdateUserPoolClientRequest$TokenValidityUnits": "The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
", + "UpdateUserPoolClientRequest$TokenValidityUnits": "The time units you use when you set the duration of ID, access, and refresh tokens. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
", "UserPoolClientType$TokenValidityUnits": "The time units used to specify the token validity times of each token type: ID, access, and refresh.
" } }, @@ -3001,11 +3062,11 @@ } }, "UserPoolAddOnsType": { - "base": "The user pool add-ons type.
", + "base": "User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
", "refs": { - "CreateUserPoolRequest$UserPoolAddOns": "Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value \"AUDIT\".
Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value \"AUDIT\".
The user pool add-ons.
" + "CreateUserPoolRequest$UserPoolAddOns": "User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
", + "UpdateUserPoolRequest$UserPoolAddOns": "User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
", + "UserPoolType$UserPoolAddOns": "User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
" } }, "UserPoolClientDescription": { @@ -3085,6 +3146,7 @@ "GetCSVHeaderResponse$UserPoolId": "The user pool ID for the user pool that the users are to be imported into.
", "GetGroupRequest$UserPoolId": "The user pool ID for the user pool.
", "GetIdentityProviderByIdentifierRequest$UserPoolId": "The user pool ID.
", + "GetLogDeliveryConfigurationRequest$UserPoolId": "The ID of the user pool where you want to view detailed activity logging configuration.
", "GetSigningCertificateRequest$UserPoolId": "The user pool ID.
", "GetUICustomizationRequest$UserPoolId": "The user pool ID for the user pool.
", "GetUserPoolMfaConfigRequest$UserPoolId": "The user pool ID.
", @@ -3097,8 +3159,10 @@ "ListUserPoolClientsRequest$UserPoolId": "The user pool ID for the user pool where you want to list user pool clients.
", "ListUsersInGroupRequest$UserPoolId": "The user pool ID for the user pool.
", "ListUsersRequest$UserPoolId": "The user pool ID for the user pool on which the search should be performed.
", + "LogDeliveryConfigurationType$UserPoolId": "The ID of the user pool where you configured detailed activity logging.
", "ResourceServerType$UserPoolId": "The user pool ID for the user pool that hosts the resource server.
", "RiskConfigurationType$UserPoolId": "The user pool ID.
", + "SetLogDeliveryConfigurationRequest$UserPoolId": "The ID of the user pool where you want to configure detailed activity logging .
", "SetRiskConfigurationRequest$UserPoolId": "The user pool ID.
", "SetUICustomizationRequest$UserPoolId": "The user pool ID for the user pool.
", "SetUserPoolMfaConfigRequest$UserPoolId": "The user pool ID.
", @@ -3183,8 +3247,8 @@ "UserStatusType": { "base": null, "refs": { - "AdminGetUserResponse$UserStatus": "The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
ARCHIVED - User is no longer active.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
The username configuration type.
", "refs": { - "CreateUserPoolRequest$UsernameConfiguration": "Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either \"username\" or \"Username\". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
", "UserPoolType$UsernameConfiguration": "Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either \"username\" or \"Username\". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
The user name.
", "AdminGetDeviceRequest$Username": "The user name.
", "AdminGetUserRequest$Username": "The user name of the user you want to retrieve.
", - "AdminGetUserResponse$Username": "The user name of the user about whom you're receiving information.
", + "AdminGetUserResponse$Username": "The username of the user that you requested.
", "AdminListDevicesRequest$Username": "The user name.
", "AdminListGroupsForUserRequest$Username": "The username for the user.
", "AdminListUserAuthEventsRequest$Username": "The user pool username or an alias.
", @@ -3248,7 +3312,7 @@ "ConfirmForgotPasswordRequest$Username": "The user name of the user for whom you want to enter a code to retrieve a forgotten password.
", "ConfirmSignUpRequest$Username": "The user name of the user whose registration you want to confirm.
", "ForgotPasswordRequest$Username": "The user name of the user for whom you want to enter a code to reset a forgotten password.
", - "GetUserResponse$Username": "The user name of the user you want to retrieve from the get user request.
", + "GetUserResponse$Username": "The username of the user that you requested.
", "ResendConfirmationCodeRequest$Username": "The username attribute of the user to whom you want to resend a confirmation code.
The user name of the user you want to register.
", "UpdateAuthEventFeedbackRequest$Username": "The user pool username.
", @@ -3259,7 +3323,7 @@ "base": null, "refs": { "ListUsersInGroupResponse$Users": "The users returned in the request to list users.
", - "ListUsersResponse$Users": "The users returned in the request to list users.
" + "ListUsersResponse$Users": "A list of the user pool users, and their attributes, that match your query.
Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.
Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
", "UserPoolClientType$EnablePropagateAdditionalUserContextData": "When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.
Valid values include:
Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using either \"username\" or \"Username\". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.
Valid values include:
Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using username, USERNAME, or UserName. This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.
Using the Amazon Cognito user pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito user pools.
For more information, see the Amazon Cognito Documentation.
', 'operations' => [ 'AddCustomAttributes' => 'Adds additional user attributes to the user pool schema.
', 'AdminAddUserToGroup' => 'Adds the specified user to the specified group.
Calling this action requires developer credentials.
', 'AdminConfirmSignUp' => 'Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action requires developer credentials.
', 'AdminCreateUser' => 'Creates a new user in the specified user pool.
If MessageAction isn\'t set, the default is to send a welcome message via email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won\'t send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.
AdminCreateUser requires developer credentials.
Deletes a user as an administrator. Works on any user.
Calling this action requires developer credentials.
', 'AdminDeleteUserAttributes' => 'Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
', 'AdminDisableProviderForUser' => 'Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can\'t use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser.
This action is enabled only for admin access and requires developer credentials.
The ProviderName must match the value specified when creating an IdP for the pool.
To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user.
The ProviderAttributeName must always be Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
Deactivates a user and revokes all access tokens for the user. A deactivated user can\'t sign in, but still appears in the responses to GetUser and ListUsers API requests.
You must make this API request with Amazon Web Services credentials that have cognito-idp:AdminDisableUser permissions.
Enables the specified user as an administrator. Works on any user.
Calling this action requires developer credentials.
', 'AdminForgetDevice' => 'Forgets the device, as an administrator.
Calling this action requires developer credentials.
', 'AdminGetDevice' => 'Gets the device, as an administrator.
Calling this action requires developer credentials.
', 'AdminGetUser' => 'Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
', 'AdminInitiateAuth' => 'Initiates the authentication flow, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
', 'AdminLinkProviderForUser' => 'Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account.
The maximum number of federated identities linked to a user is five.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner.
This action is administrative and requires developer credentials.
', 'AdminListDevices' => 'Lists devices, as an administrator.
Calling this action requires developer credentials.
', 'AdminListGroupsForUser' => 'Lists the groups that the user belongs to.
Calling this action requires developer credentials.
', 'AdminListUserAuthEvents' => 'A history of user activity and any risks detected as part of Amazon Cognito advanced security.
', 'AdminRemoveUserFromGroup' => 'Removes the specified user from the specified group.
Calling this action requires developer credentials.
', 'AdminResetUserPassword' => 'Resets the specified user\'s password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
', 'AdminRespondToAuthChallenge' => 'Responds to an authentication challenge, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
', 'AdminSetUserMFAPreference' => 'The user\'s multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
', 'AdminSetUserPassword' => 'Sets the specified user\'s password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn\'t sign in before it expires, the user won\'t be able to sign in, and an administrator must reset their password.
Once the user has set a new password, or the password is permanent, the user status is set to Confirmed.
This action is no longer supported. You can use it to configure only SMS MFA. You can\'t use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
', 'AdminUpdateAuthEventFeedback' => 'Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
', 'AdminUpdateDeviceStatus' => 'Updates the device status as an administrator.
Calling this action requires developer credentials.
', 'AdminUpdateUserAttributes' => 'Updates the specified user\'s attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
', 'AdminUserGlobalSignOut' => 'Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user\'s current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they\'re issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.
Calling this action requires developer credentials.
', 'AssociateSoftwareToken' => 'Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user\'s access token, or a session string from a challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don\'t verify the software token and your user pool doesn\'t require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user\'s TOTP.
Changes the password for a specified user in a user pool.
', 'ConfirmDevice' => 'Confirms tracking of the device. This API call is the call that begins device tracking.
', 'ConfirmForgotPassword' => 'Allows a user to enter a confirmation code to reset a forgotten password.
', 'ConfirmSignUp' => 'Confirms registration of a new user.
', 'CreateGroup' => 'Creates a new group in the specified user pool.
Calling this action requires developer credentials.
', 'CreateIdentityProvider' => 'Creates an IdP for a user pool.
', 'CreateResourceServer' => 'Creates a new OAuth2.0 resource server and defines custom scopes within it.
', 'CreateUserImportJob' => 'Creates the user import job.
', 'CreateUserPool' => 'Creates a new Amazon Cognito user pool and sets the password policy for the pool.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
', 'CreateUserPoolDomain' => 'Creates a new domain for a user pool.
', 'DeleteGroup' => 'Deletes a group.
Calling this action requires developer credentials.
', 'DeleteIdentityProvider' => 'Deletes an IdP for a user pool.
', 'DeleteResourceServer' => 'Deletes a resource server.
', 'DeleteUser' => 'Allows a user to delete himself or herself.
', 'DeleteUserAttributes' => 'Deletes the attributes for a user.
', 'DeleteUserPool' => 'Deletes the specified Amazon Cognito user pool.
', 'DeleteUserPoolClient' => 'Allows the developer to delete the user pool client.
', 'DeleteUserPoolDomain' => 'Deletes a domain for a user pool.
', 'DescribeIdentityProvider' => 'Gets information about a specific IdP.
', 'DescribeResourceServer' => 'Describes a resource server.
', 'DescribeRiskConfiguration' => 'Describes the risk configuration.
', 'DescribeUserImportJob' => 'Describes the user import job.
', 'DescribeUserPool' => 'Returns the configuration information and metadata of the specified user pool.
', 'DescribeUserPoolClient' => 'Client method for returning the configuration information and metadata of the specified user pool app client.
', 'DescribeUserPoolDomain' => 'Gets information about a domain.
', 'ForgetDevice' => 'Forgets the specified device.
', 'ForgotPassword' => 'Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user\'s password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
', 'GetDevice' => 'Gets the device.
', 'GetGroup' => 'Gets a group.
Calling this action requires developer credentials.
', 'GetIdentityProviderByIdentifier' => 'Gets the specified IdP.
', 'GetSigningCertificate' => 'This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.
Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to GetSigningCertificate, but doesn\'t invalidate the original certificate.
Gets the user interface (UI) Customization information for a particular app client\'s app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app clientId is ALL), then that information is returned. If nothing is present, then an empty shape is returned.
Gets the user attributes and metadata for a user.
', 'GetUserAttributeVerificationCode' => 'Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Gets the user pool multi-factor authentication (MFA) configuration.
', 'GlobalSignOut' => 'Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.
', 'InitiateAuth' => 'Initiates sign-in for a user in the Amazon Cognito user directory. You can\'t sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Lists the sign-in devices that Amazon Cognito has registered to the current user.
', 'ListGroups' => 'Lists the groups associated with a user pool.
Calling this action requires developer credentials.
', 'ListIdentityProviders' => 'Lists information about all IdPs for a user pool.
', 'ListResourceServers' => 'Lists the resource servers for a user pool.
', 'ListTagsForResource' => 'Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
', 'ListUserImportJobs' => 'Lists the user import jobs.
', 'ListUserPoolClients' => 'Lists the clients that have been created for the specified user pool.
', 'ListUserPools' => 'Lists the user pools associated with an Amazon Web Services account.
', 'ListUsers' => 'Lists the users in the Amazon Cognito user pool.
', 'ListUsersInGroup' => 'Lists the users in the specified group.
Calling this action requires developer credentials.
', 'ResendConfirmationCode' => 'Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Responds to the authentication challenge.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can\'t use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.
', 'SetRiskConfiguration' => 'Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.
To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
Sets the user interface (UI) customization information for a user pool\'s built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app\'s pages, and the service will throw an error.
Set the user\'s multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
', 'SetUserPoolMfaConfig' => 'Sets the user pool multi-factor authentication (MFA) configuration.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This action is no longer supported. You can use it to configure only SMS MFA. You can\'t use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
', 'SignUp' => 'Registers the user in the specified user pool and creates a user name, password, and user attributes.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Starts the user import.
', 'StopUserImportJob' => 'Stops the user import job.
', 'TagResource' => 'Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool, and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
', 'UntagResource' => 'Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.
', 'UpdateAuthEventFeedback' => 'Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
', 'UpdateDeviceStatus' => 'Updates the device status.
', 'UpdateGroup' => 'Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
', 'UpdateIdentityProvider' => 'Updates IdP information for a user pool.
', 'UpdateResourceServer' => 'Updates the name and scopes of resource server. All other fields are read-only.
If you don\'t provide a value for an attribute, it is set to the default value.
Allows a user to update a specific attribute (one at a time).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don\'t provide a value for an attribute, it will be set to the default value.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don\'t provide a value for an attribute, it will be set to the default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
', 'UpdateUserPoolDomain' => 'Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can\'t use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
', 'VerifySoftwareToken' => 'Use this API to register a user\'s entered time-based one-time password (TOTP) code and mark the user\'s software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
', 'VerifyUserAttribute' => 'Verifies the specified user attributes in the user pool.
If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
', ], 'shapes' => [ 'AWSAccountIdType' => [ 'base' => NULL, 'refs' => [ 'DomainDescriptionType$AWSAccountId' => 'The Amazon Web Services ID for the user pool owner.
', ], ], 'AccessTokenValidityType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$AccessTokenValidity' => 'The access token time limit. After this limit expires, your user can\'t use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
', 'UpdateUserPoolClientRequest$AccessTokenValidity' => 'The access token time limit. After this limit expires, your user can\'t use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
', 'UserPoolClientType$AccessTokenValidity' => 'The access token time limit. After this limit expires, your user can\'t use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
', ], ], 'AccountRecoverySettingType' => [ 'base' => 'The data type for AccountRecoverySetting.
The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn\'t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn\'t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn\'t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
Flag specifying whether to send a notification.
', ], ], 'AccountTakeoverActionType' => [ 'base' => 'Account takeover action type.
', 'refs' => [ 'AccountTakeoverActionsType$LowAction' => 'Action to take for a low risk.
', 'AccountTakeoverActionsType$MediumAction' => 'Action to take for a medium risk.
', 'AccountTakeoverActionsType$HighAction' => 'Action to take for a high risk.
', ], ], 'AccountTakeoverActionsType' => [ 'base' => 'Account takeover actions type.
', 'refs' => [ 'AccountTakeoverRiskConfigurationType$Actions' => 'Account takeover risk configuration actions.
', ], ], 'AccountTakeoverEventActionType' => [ 'base' => NULL, 'refs' => [ 'AccountTakeoverActionType$EventAction' => 'The action to take in response to the account takeover action. Valid values are as follows:
BLOCK Choosing this action will block the request.
MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.
MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.
NO_ACTION Allow the user to sign in.
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
', 'refs' => [ 'RiskConfigurationType$AccountTakeoverRiskConfiguration' => 'The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.
The account takeover risk configuration.
', ], ], 'AddCustomAttributesRequest' => [ 'base' => 'Represents the request to add custom attributes.
', 'refs' => [], ], 'AddCustomAttributesResponse' => [ 'base' => 'Represents the response from the server for the request to add custom attributes.
', 'refs' => [], ], 'AdminAddUserToGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminConfirmSignUpRequest' => [ 'base' => 'Represents the request to confirm user registration.
', 'refs' => [], ], 'AdminConfirmSignUpResponse' => [ 'base' => 'Represents the response from the server for the request to confirm registration.
', 'refs' => [], ], 'AdminCreateUserConfigType' => [ 'base' => 'The configuration for creating a new user profile.
', 'refs' => [ 'CreateUserPoolRequest$AdminCreateUserConfig' => 'The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
Represents the request to create a user in the specified user pool.
', 'refs' => [], ], 'AdminCreateUserResponse' => [ 'base' => 'Represents the response from the server to the request to create the user.
', 'refs' => [], ], 'AdminCreateUserUnusedAccountValidityDaysType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserConfigType$UnusedAccountValidityDays' => 'The user account expiration limit, in days, after which a new account that hasn\'t signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.
If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.
Represents the request to delete user attributes as an administrator.
', 'refs' => [], ], 'AdminDeleteUserAttributesResponse' => [ 'base' => 'Represents the response received from the server for a request to delete user attributes.
', 'refs' => [], ], 'AdminDeleteUserRequest' => [ 'base' => 'Represents the request to delete a user as an administrator.
', 'refs' => [], ], 'AdminDisableProviderForUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminDisableProviderForUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminDisableUserRequest' => [ 'base' => 'Represents the request to disable the user as an administrator.
', 'refs' => [], ], 'AdminDisableUserResponse' => [ 'base' => 'Represents the response received from the server to disable the user as an administrator.
', 'refs' => [], ], 'AdminEnableUserRequest' => [ 'base' => 'Represents the request that enables the user as an administrator.
', 'refs' => [], ], 'AdminEnableUserResponse' => [ 'base' => 'Represents the response from the server for the request to enable a user as an administrator.
', 'refs' => [], ], 'AdminForgetDeviceRequest' => [ 'base' => 'Sends the forgot device request, as an administrator.
', 'refs' => [], ], 'AdminGetDeviceRequest' => [ 'base' => 'Represents the request to get the device, as an administrator.
', 'refs' => [], ], 'AdminGetDeviceResponse' => [ 'base' => 'Gets the device response, as an administrator.
', 'refs' => [], ], 'AdminGetUserRequest' => [ 'base' => 'Represents the request to get the specified user as an administrator.
', 'refs' => [], ], 'AdminGetUserResponse' => [ 'base' => 'Represents the response from the server from the request to get the specified user as an administrator.
', 'refs' => [], ], 'AdminInitiateAuthRequest' => [ 'base' => 'Initiates the authorization request, as an administrator.
', 'refs' => [], ], 'AdminInitiateAuthResponse' => [ 'base' => 'Initiates the authentication response, as an administrator.
', 'refs' => [], ], 'AdminLinkProviderForUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminLinkProviderForUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminListDevicesRequest' => [ 'base' => 'Represents the request to list devices, as an administrator.
', 'refs' => [], ], 'AdminListDevicesResponse' => [ 'base' => 'Lists the device\'s response, as an administrator.
', 'refs' => [], ], 'AdminListGroupsForUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminListGroupsForUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminListUserAuthEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminListUserAuthEventsResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminRemoveUserFromGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminResetUserPasswordRequest' => [ 'base' => 'Represents the request to reset a user\'s password as an administrator.
', 'refs' => [], ], 'AdminResetUserPasswordResponse' => [ 'base' => 'Represents the response from the server to reset a user password as an administrator.
', 'refs' => [], ], 'AdminRespondToAuthChallengeRequest' => [ 'base' => 'The request to respond to the authentication challenge, as an administrator.
', 'refs' => [], ], 'AdminRespondToAuthChallengeResponse' => [ 'base' => 'Responds to the authentication challenge, as an administrator.
', 'refs' => [], ], 'AdminSetUserMFAPreferenceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminSetUserMFAPreferenceResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminSetUserPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminSetUserPasswordResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminSetUserSettingsRequest' => [ 'base' => 'You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
', 'refs' => [], ], 'AdminSetUserSettingsResponse' => [ 'base' => 'Represents the response from the server to set user settings as an administrator.
', 'refs' => [], ], 'AdminUpdateAuthEventFeedbackRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminUpdateAuthEventFeedbackResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminUpdateDeviceStatusRequest' => [ 'base' => 'The request to update the device status, as an administrator.
', 'refs' => [], ], 'AdminUpdateDeviceStatusResponse' => [ 'base' => 'The status response to the request to update the device, as an administrator.
', 'refs' => [], ], 'AdminUpdateUserAttributesRequest' => [ 'base' => 'Represents the request to update the user\'s attributes as an administrator.
', 'refs' => [], ], 'AdminUpdateUserAttributesResponse' => [ 'base' => 'Represents the response from the server for the request to update user attributes as an administrator.
', 'refs' => [], ], 'AdminUserGlobalSignOutRequest' => [ 'base' => 'The request to sign out of all devices, as an administrator.
', 'refs' => [], ], 'AdminUserGlobalSignOutResponse' => [ 'base' => 'The global sign-out response, as an administrator.
', 'refs' => [], ], 'AdvancedSecurityModeType' => [ 'base' => NULL, 'refs' => [ 'UserPoolAddOnsType$AdvancedSecurityMode' => 'The advanced security mode.
', ], ], 'AliasAttributeType' => [ 'base' => NULL, 'refs' => [ 'AliasAttributesListType$member' => NULL, ], ], 'AliasAttributesListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$AliasAttributes' => 'Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
', 'UserPoolType$AliasAttributes' => 'The attributes that are aliased in a user pool.
', ], ], 'AliasExistsException' => [ 'base' => 'This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you\'ve configured to use email address or phone number as a sign-in alias.
', 'refs' => [], ], 'AnalyticsConfigurationType' => [ 'base' => 'The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
In Regions where Amazon Pinpointisn\'t available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn\'t available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn\'t available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The Amazon Pinpoint analytics configuration for the user pool client.
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
An Amazon Pinpoint analytics endpoint.
An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.
', 'refs' => [ 'AdminInitiateAuthRequest$AnalyticsMetadata' => 'The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.
The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
', 'AnalyticsConfigurationType$RoleArn' => 'The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
', 'CreateGroupRequest$RoleArn' => 'The role Amazon Resource Name (ARN) for the group.
', 'CreateUserImportJobRequest$CloudWatchLogsRoleArn' => 'The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
', 'CustomDomainConfigType$CertificateArn' => 'The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
', 'CustomEmailLambdaVersionConfigType$LambdaArn' => 'The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.
', 'CustomSMSLambdaVersionConfigType$LambdaArn' => 'The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.
', 'EmailConfigurationType$SourceArn' => 'The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.
The role Amazon Resource Name (ARN) for the group.
', 'LambdaConfigType$PreSignUp' => 'A pre-registration Lambda trigger.
', 'LambdaConfigType$CustomMessage' => 'A custom Message Lambda trigger.
', 'LambdaConfigType$PostConfirmation' => 'A post-confirmation Lambda trigger.
', 'LambdaConfigType$PreAuthentication' => 'A pre-authentication Lambda trigger.
', 'LambdaConfigType$PostAuthentication' => 'A post-authentication Lambda trigger.
', 'LambdaConfigType$DefineAuthChallenge' => 'Defines the authentication challenge.
', 'LambdaConfigType$CreateAuthChallenge' => 'Creates an authentication challenge.
', 'LambdaConfigType$VerifyAuthChallengeResponse' => 'Verifies the authentication challenge response.
', 'LambdaConfigType$PreTokenGeneration' => 'A Lambda trigger that is invoked before token generation.
', 'LambdaConfigType$UserMigration' => 'The user migration Lambda config type.
', 'LambdaConfigType$KMSKeyID' => 'The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.
The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
', 'NotifyConfigurationType$SourceArn' => 'The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the From parameter.
The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
', 'TagResourceRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the user pool to assign the tags to.
', 'UntagResourceRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
', 'UpdateGroupRequest$RoleArn' => 'The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.
The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
', 'UserPoolType$Arn' => 'The Amazon Resource Name (ARN) for the user pool.
', ], ], 'AssociateSoftwareTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateSoftwareTokenResponse' => [ 'base' => NULL, 'refs' => [], ], 'AttributeDataType' => [ 'base' => NULL, 'refs' => [ 'SchemaAttributeType$AttributeDataType' => 'The attribute data type.
', ], ], 'AttributeListType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserRequest$UserAttributes' => 'An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).
For custom attributes, you must prepend the custom: prefix to the attribute name.
To send a message inviting the user to sign up, you must specify the user\'s email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling AdminUpdateUserAttributes.
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
The user\'s validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user\'s domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user\'s validation data isn\'t persisted.
', 'AdminGetUserResponse$UserAttributes' => 'An array of name-value pairs representing user attributes.
', 'AdminUpdateUserAttributesRequest$UserAttributes' => 'An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
To update the value of an attribute that requires verification in the same API request, include the email_verified or phone_number_verified attribute, with a value of true. If you set the email_verified or phone_number_verified value for an email or phone_number attribute that requires verification to true, Amazon Cognito doesn’t send a verification message to your user.
The device attributes.
', 'GetUserResponse$UserAttributes' => 'An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
The validation data in the request to register a user.
', 'UpdateUserAttributesRequest$UserAttributes' => 'An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
', 'UserType$Attributes' => 'A container with information about the user type attributes.
', ], ], 'AttributeMappingKeyType' => [ 'base' => NULL, 'refs' => [ 'AttributeMappingType$key' => NULL, ], ], 'AttributeMappingType' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$AttributeMapping' => 'A mapping of IdP attributes to standard and custom user pool attributes.
', 'IdentityProviderType$AttributeMapping' => 'A mapping of IdP attributes to standard and custom user pool attributes.
', 'UpdateIdentityProviderRequest$AttributeMapping' => 'The IdP attribute mapping to be changed.
', ], ], 'AttributeNameListType' => [ 'base' => NULL, 'refs' => [ 'AdminDeleteUserAttributesRequest$UserAttributeNames' => 'An array of strings representing the user attribute names you want to delete.
For custom attributes, you must prepend the custom: prefix to the attribute name.
An array of strings representing the user attribute names you want to delete.
For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
The name of the attribute.
', 'CodeDeliveryDetailsType$AttributeName' => 'The name of the attribute that Amazon Cognito verifies with the code.
', 'GetUserAttributeVerificationCodeRequest$AttributeName' => 'The attribute name returned by the server response to get the user attribute verification code.
', 'MFAOptionType$AttributeName' => 'The attribute name of the MFA option type. The only valid value is phone_number.
The attribute name in the request to verify user attributes.
', ], ], 'AttributeType' => [ 'base' => 'Specifies whether the attribute is standard or custom.
', 'refs' => [ 'AttributeListType$member' => NULL, ], ], 'AttributeValueType' => [ 'base' => NULL, 'refs' => [ 'AttributeType$Value' => 'The value of the attribute.
', ], ], 'AttributesRequireVerificationBeforeUpdateType' => [ 'base' => NULL, 'refs' => [ 'UserAttributeUpdateSettingsType$AttributesRequireVerificationBeforeUpdate' => 'Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.
You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.
When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn\'t require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.
The authentication event type.
', 'refs' => [ 'AuthEventsType$member' => NULL, ], ], 'AuthEventsType' => [ 'base' => NULL, 'refs' => [ 'AdminListUserAuthEventsResponse$AuthEvents' => 'The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse.
The authentication flow for this call to run. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution.
ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.
The authentication flow for this call to run. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns the next challenge or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn\'t find the user name in the user pool.
ADMIN_NO_SRP_AUTH isn\'t a valid value.
The authentication parameters. These are inputs corresponding to the AuthFlow that you\'re invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
The authentication parameters. These are inputs corresponding to the AuthFlow that you\'re invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
The authentication result.
', 'refs' => [ 'AdminInitiateAuthResponse$AuthenticationResult' => 'The result of the authentication response. This is only returned if the caller doesn\'t need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
The result returned by the server in response to the authentication request.
', 'InitiateAuthResponse$AuthenticationResult' => 'The result of the authentication response. This result is only returned if the caller doesn\'t need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
The result returned by the server in response to the request to respond to the authentication challenge.
', ], ], 'BlockedIPRangeListType' => [ 'base' => NULL, 'refs' => [ 'RiskExceptionConfigurationType$BlockedIPRangeList' => 'Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.
', ], ], 'BooleanType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserConfigType$AllowAdminCreateUserOnly' => 'Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
Indicates that the status is enabled.
True if the password is permanent, False if it is temporary.
If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
Indicates whether the user confirmation must confirm the device response.
', 'CreateUserPoolClientRequest$AllowedOAuthFlowsUserPoolClient' => 'Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
', 'DeviceConfigurationType$ChallengeRequiredOnNewDevice' => 'When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
When true, Amazon Cognito doesn\'t automatically remember a user\'s device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user\'s choice in an UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.
In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
', 'PasswordPolicyType$RequireLowercase' => 'In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
', 'PasswordPolicyType$RequireNumbers' => 'In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
', 'PasswordPolicyType$RequireSymbols' => 'In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
', 'SMSMfaSettingsType$Enabled' => 'Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.
', 'SMSMfaSettingsType$PreferredMfa' => 'Specifies whether SMS is the preferred MFA method.
', 'SchemaAttributeType$DeveloperOnlyAttribute' => 'You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.
Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won\'t be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can\'t be updated using UpdateUserAttributes.
Specifies whether the value of the attribute can be changed.
For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
Specifies whether a user pool attribute is required. If the attribute is required and the user doesn\'t provide a value, registration or sign-in will fail.
', 'SignUpResponse$UserConfirmed' => 'A response from the server indicating that a user registration has been confirmed.
', 'SoftwareTokenMfaConfigType$Enabled' => 'Specifies whether software token MFA is activated.
', 'SoftwareTokenMfaSettingsType$Enabled' => 'Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.
', 'SoftwareTokenMfaSettingsType$PreferredMfa' => 'Specifies whether software token MFA is the preferred MFA method.
', 'UpdateUserPoolClientRequest$AllowedOAuthFlowsUserPoolClient' => 'Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
', 'UserPoolClientType$AllowedOAuthFlowsUserPoolClient' => 'Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
', 'UserType$Enabled' => 'Specifies whether the user is enabled.
', ], ], 'CSSType' => [ 'base' => NULL, 'refs' => [ 'SetUICustomizationRequest$CSS' => 'The CSS values in the UI customization.
', 'UICustomizationType$CSS' => 'The CSS values in the UI customization.
', ], ], 'CSSVersionType' => [ 'base' => NULL, 'refs' => [ 'UICustomizationType$CSSVersion' => 'The CSS version number.
', ], ], 'CallbackURLsListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$CallbackURLs' => 'A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
', 'UpdateUserPoolClientRequest$CallbackURLs' => 'A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
', ], ], 'ChallengeName' => [ 'base' => NULL, 'refs' => [ 'ChallengeResponseType$ChallengeName' => 'The challenge name.
', ], ], 'ChallengeNameType' => [ 'base' => NULL, 'refs' => [ 'AdminInitiateAuthResponse$ChallengeName' => 'The name of the challenge that you\'re responding to with this call. This is returned in the AdminInitiateAuth response if you must pass another challenge.
MFA_SETUP: If MFA is required, users who don\'t have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate.
SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) software token MFA.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren\'t required by your user pool and that your app client can write. For more information, see AdminRespondToAuthChallenge.
In a NEW_PASSWORD_REQUIRED challenge response, you can\'t modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, users will need help from an administrator to add a phone number to their account and then call InitiateAuth again to restart sign-in.
The challenge name. For more information, see AdminInitiateAuth.
', 'AdminRespondToAuthChallengeResponse$ChallengeName' => 'The name of the challenge. For more information, see AdminInitiateAuth.
', 'InitiateAuthResponse$ChallengeName' => 'The name of the challenge that you\'re responding to with this call. This name is returned in the AdminInitiateAuth response if you must pass another challenge.
Valid values include the following:
All of the following challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login.
Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren\'t required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge.
In a NEW_PASSWORD_REQUIRED challenge response, you can\'t modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call InitiateAuth again to restart sign-in.
The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH isn\'t a valid value.
The challenge name. For more information, see InitiateAuth.
', ], ], 'ChallengeParametersType' => [ 'base' => NULL, 'refs' => [ 'AdminInitiateAuthResponse$ChallengeParameters' => 'The challenge parameters. These are returned to you in the AdminInitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
The value of the USER_ID_FOR_SRP attribute is the user\'s actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute can\'t be an alias.
The challenge parameters. For more information, see AdminInitiateAuth.
', 'InitiateAuthResponse$ChallengeParameters' => 'The challenge parameters. These are returned in the InitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
The challenge parameters. For more information, see InitiateAuth.
', ], ], 'ChallengeResponse' => [ 'base' => NULL, 'refs' => [ 'ChallengeResponseType$ChallengeResponse' => 'The challenge response.
', ], ], 'ChallengeResponseListType' => [ 'base' => NULL, 'refs' => [ 'AuthEventType$ChallengeResponses' => 'The challenge responses.
', ], ], 'ChallengeResponseType' => [ 'base' => 'The challenge response type.
', 'refs' => [ 'ChallengeResponseListType$member' => NULL, ], ], 'ChallengeResponsesType' => [ 'base' => NULL, 'refs' => [ 'AdminRespondToAuthChallengeRequest$ChallengeResponses' => 'The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren\'t required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can\'t modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
The value of the USERNAME attribute must be the user\'s actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).
SMS_MFA: SMS_MFA_CODE, USERNAME.
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.
PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren\'t required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can\'t modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
Represents the request to change a user password.
', 'refs' => [], ], 'ChangePasswordResponse' => [ 'base' => 'The response from the server to the change password request.
', 'refs' => [], ], 'ClientIdType' => [ 'base' => NULL, 'refs' => [ 'AdminInitiateAuthRequest$ClientId' => 'The app client ID.
', 'AdminRespondToAuthChallengeRequest$ClientId' => 'The app client ID.
', 'ConfirmForgotPasswordRequest$ClientId' => 'The app client ID of the app associated with the user pool.
', 'ConfirmSignUpRequest$ClientId' => 'The ID of the app client associated with the user pool.
', 'DeleteUserPoolClientRequest$ClientId' => 'The app client ID of the app associated with the user pool.
', 'DescribeRiskConfigurationRequest$ClientId' => 'The app client ID.
', 'DescribeUserPoolClientRequest$ClientId' => 'The app client ID of the app associated with the user pool.
', 'ForgotPasswordRequest$ClientId' => 'The ID of the client associated with the user pool.
', 'GetUICustomizationRequest$ClientId' => 'The client ID for the client app.
', 'InitiateAuthRequest$ClientId' => 'The app client ID.
', 'ResendConfirmationCodeRequest$ClientId' => 'The ID of the client associated with the user pool.
', 'RespondToAuthChallengeRequest$ClientId' => 'The app client ID.
', 'RevokeTokenRequest$ClientId' => 'The client ID for the token that you want to revoke.
', 'RiskConfigurationType$ClientId' => 'The app client ID.
', 'SetRiskConfigurationRequest$ClientId' => 'The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.
Otherwise, ClientId is mapped to the client. When the client ID isn\'t null, the user pool configuration is overridden and the risk configuration for the client is used instead.
The client ID for the client app.
', 'SignUpRequest$ClientId' => 'The ID of the client associated with the user pool.
', 'UICustomizationType$ClientId' => 'The client ID for the client app.
', 'UpdateUserPoolClientRequest$ClientId' => 'The ID of the client associated with the user pool.
', 'UserPoolClientDescription$ClientId' => 'The ID of the client associated with the user pool.
', 'UserPoolClientType$ClientId' => 'The ID of the client associated with the user pool.
', ], ], 'ClientMetadataType' => [ 'base' => NULL, 'refs' => [ 'AdminConfirmSignUpRequest$ClientMetadata' => 'A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
Pre signup
Pre authentication
User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn\'t provide the ClientMetadata value as input:
Post authentication
Custom message
Pre token generation
Create auth challenge
Define auth challenge
Verify auth challenge
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
pre sign-up
custom message
post authentication
user migration
pre token generation
define auth challenge
create auth challenge
verify auth challenge response
When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
Pre signup
Pre authentication
User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn\'t provide the ClientMetadata value as input:
Post authentication
Custom message
Pre token generation
Create auth challenge
Define auth challenge
Verify auth challenge
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
The client name for the user pool client you would like to create.
', 'UpdateUserPoolClientRequest$ClientName' => 'The client name from the update user pool client request.
', 'UserPoolClientDescription$ClientName' => 'The client name from the user pool client description.
', 'UserPoolClientType$ClientName' => 'The client name from the user pool request of the client type.
', ], ], 'ClientPermissionListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$ReadAttributes' => 'The read attributes.
', 'CreateUserPoolClientRequest$WriteAttributes' => 'The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
', 'UpdateUserPoolClientRequest$ReadAttributes' => 'The read-only attributes of the user pool.
', 'UpdateUserPoolClientRequest$WriteAttributes' => 'The writeable attributes of the user pool.
', 'UserPoolClientType$ReadAttributes' => 'The Read-only attributes.
', 'UserPoolClientType$WriteAttributes' => 'The writeable attributes.
', ], ], 'ClientPermissionType' => [ 'base' => NULL, 'refs' => [ 'ClientPermissionListType$member' => NULL, ], ], 'ClientSecretType' => [ 'base' => NULL, 'refs' => [ 'RevokeTokenRequest$ClientSecret' => 'The secret for the client ID. This is required only if the client ID has a secret.
', 'UserPoolClientType$ClientSecret' => 'The client secret from the user pool request of the client type.
', ], ], 'CodeDeliveryDetailsListType' => [ 'base' => NULL, 'refs' => [ 'UpdateUserAttributesResponse$CodeDeliveryDetailsList' => 'The code delivery details list from the server for the request to update user attributes.
', ], ], 'CodeDeliveryDetailsType' => [ 'base' => 'The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.
', 'refs' => [ 'CodeDeliveryDetailsListType$member' => NULL, 'ForgotPasswordResponse$CodeDeliveryDetails' => 'The code delivery details returned by the server in response to the request to reset a password.
', 'GetUserAttributeVerificationCodeResponse$CodeDeliveryDetails' => 'The code delivery details returned by the server in response to the request to get the user attribute verification code.
', 'ResendConfirmationCodeResponse$CodeDeliveryDetails' => 'The code delivery details returned by the server in response to the request to resend the confirmation code.
', 'SignUpResponse$CodeDeliveryDetails' => 'The code delivery details returned by the server response to the user registration request.
', ], ], 'CodeDeliveryFailureException' => [ 'base' => 'This exception is thrown when a verification code fails to deliver successfully.
', 'refs' => [], ], 'CodeMismatchException' => [ 'base' => 'This exception is thrown if the provided code doesn\'t match what the server was expecting.
', 'refs' => [], ], 'CompletionMessageType' => [ 'base' => NULL, 'refs' => [ 'UserImportJobType$CompletionMessage' => 'The message returned when the user import job is completed.
', ], ], 'CompromisedCredentialsActionsType' => [ 'base' => 'The compromised credentials actions type.
', 'refs' => [ 'CompromisedCredentialsRiskConfigurationType$Actions' => 'The compromised credentials risk configuration actions.
', ], ], 'CompromisedCredentialsEventActionType' => [ 'base' => NULL, 'refs' => [ 'CompromisedCredentialsActionsType$EventAction' => 'The event action.
', ], ], 'CompromisedCredentialsRiskConfigurationType' => [ 'base' => 'The compromised credentials risk configuration type.
', 'refs' => [ 'RiskConfigurationType$CompromisedCredentialsRiskConfiguration' => 'The compromised credentials risk configuration object, including the EventFilter and the EventAction.
The compromised credentials risk configuration.
', ], ], 'ConcurrentModificationException' => [ 'base' => 'This exception is thrown if two or more modifications are happening concurrently.
', 'refs' => [], ], 'ConfirmDeviceRequest' => [ 'base' => 'Confirms the device request.
', 'refs' => [], ], 'ConfirmDeviceResponse' => [ 'base' => 'Confirms the device response.
', 'refs' => [], ], 'ConfirmForgotPasswordRequest' => [ 'base' => 'The request representing the confirmation for a password reset.
', 'refs' => [], ], 'ConfirmForgotPasswordResponse' => [ 'base' => 'The response from the server that results from a user\'s request to retrieve a forgotten password.
', 'refs' => [], ], 'ConfirmSignUpRequest' => [ 'base' => 'Represents the request to confirm registration of a user.
', 'refs' => [], ], 'ConfirmSignUpResponse' => [ 'base' => 'Represents the response from the server for the registration confirmation.
', 'refs' => [], ], 'ConfirmationCodeType' => [ 'base' => NULL, 'refs' => [ 'ConfirmForgotPasswordRequest$ConfirmationCode' => 'The confirmation code from your user\'s request to reset their password. For more information, see ForgotPassword.
', 'ConfirmSignUpRequest$ConfirmationCode' => 'The confirmation code sent by a user\'s request to confirm registration.
', 'VerifyUserAttributeRequest$Code' => 'The verification code in the request to verify user attributes.
', ], ], 'ContextDataType' => [ 'base' => 'Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
', 'refs' => [ 'AdminInitiateAuthRequest$ContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'AdminRespondToAuthChallengeRequest$ContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', ], ], 'CreateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIdentityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIdentityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResourceServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResourceServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserImportJobRequest' => [ 'base' => 'Represents the request to create the user import job.
', 'refs' => [], ], 'CreateUserImportJobResponse' => [ 'base' => 'Represents the response from the server to the request to create the user import job.
', 'refs' => [], ], 'CreateUserPoolClientRequest' => [ 'base' => 'Represents the request to create a user pool client.
', 'refs' => [], ], 'CreateUserPoolClientResponse' => [ 'base' => 'Represents the response from the server to create a user pool client.
', 'refs' => [], ], 'CreateUserPoolDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserPoolDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserPoolRequest' => [ 'base' => 'Represents the request to create a user pool.
', 'refs' => [], ], 'CreateUserPoolResponse' => [ 'base' => 'Represents the response from the server for the request to create a user pool.
', 'refs' => [], ], 'CustomAttributeNameType' => [ 'base' => NULL, 'refs' => [ 'SchemaAttributeType$Name' => 'A schema attribute of the name type.
', ], ], 'CustomAttributesListType' => [ 'base' => NULL, 'refs' => [ 'AddCustomAttributesRequest$CustomAttributes' => 'An array of custom attributes, such as Mutable and Name.
', ], ], 'CustomDomainConfigType' => [ 'base' => 'The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
', 'refs' => [ 'CreateUserPoolDomainRequest$CustomDomainConfig' => 'The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
', 'DomainDescriptionType$CustomDomainConfig' => 'The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
', 'UpdateUserPoolDomainRequest$CustomDomainConfig' => 'The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
', ], ], 'CustomEmailLambdaVersionConfigType' => [ 'base' => 'A custom email sender Lambda configuration type.
', 'refs' => [ 'LambdaConfigType$CustomEmailSender' => 'A custom email sender Lambda trigger.
', ], ], 'CustomEmailSenderLambdaVersionType' => [ 'base' => NULL, 'refs' => [ 'CustomEmailLambdaVersionConfigType$LambdaVersion' => 'Signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0.
A custom SMS sender Lambda configuration type.
', 'refs' => [ 'LambdaConfigType$CustomSMSSender' => 'A custom SMS sender Lambda trigger.
', ], ], 'CustomSMSSenderLambdaVersionType' => [ 'base' => NULL, 'refs' => [ 'CustomSMSLambdaVersionConfigType$LambdaVersion' => 'Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.
The date the user was created.
', 'AdminGetUserResponse$UserLastModifiedDate' => 'The date the user was last modified.
', 'AuthEventType$CreationDate' => 'The creation date
', 'DeviceType$DeviceCreateDate' => 'The creation date of the device.
', 'DeviceType$DeviceLastModifiedDate' => 'The last modified date of the device.
', 'DeviceType$DeviceLastAuthenticatedDate' => 'The date when the device was last authenticated.
', 'EventFeedbackType$FeedbackDate' => 'The event feedback date.
', 'GroupType$LastModifiedDate' => 'The date the group was last modified.
', 'GroupType$CreationDate' => 'The date the group was created.
', 'IdentityProviderType$LastModifiedDate' => 'The date the IdP was last modified.
', 'IdentityProviderType$CreationDate' => 'The date the IdP was created.
', 'ProviderDescription$LastModifiedDate' => 'The date the provider was last modified.
', 'ProviderDescription$CreationDate' => 'The date the provider was added to the user pool.
', 'RiskConfigurationType$LastModifiedDate' => 'The last modified date.
', 'UICustomizationType$LastModifiedDate' => 'The last-modified date for the UI customization.
', 'UICustomizationType$CreationDate' => 'The creation date for the UI customization.
', 'UserImportJobType$CreationDate' => 'The date the user import job was created.
', 'UserImportJobType$StartDate' => 'The date when the user import job was started.
', 'UserImportJobType$CompletionDate' => 'The date when the user import job was completed.
', 'UserPoolClientType$LastModifiedDate' => 'The date the user pool client was last modified.
', 'UserPoolClientType$CreationDate' => 'The date the user pool client was created.
', 'UserPoolDescriptionType$LastModifiedDate' => 'The date the user pool description was last modified.
', 'UserPoolDescriptionType$CreationDate' => 'The date the user pool description was created.
', 'UserPoolType$LastModifiedDate' => 'The date the user pool was last modified.
', 'UserPoolType$CreationDate' => 'The date the user pool was created.
', 'UserType$UserCreateDate' => 'The creation date of the user.
', 'UserType$UserLastModifiedDate' => 'The last modified date of the user.
', ], ], 'DefaultEmailOptionType' => [ 'base' => NULL, 'refs' => [ 'VerificationMessageTemplateType$DefaultEmailOption' => 'The default email option.
', ], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIdentityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserAttributesRequest' => [ 'base' => 'Represents the request to delete user attributes.
', 'refs' => [], ], 'DeleteUserAttributesResponse' => [ 'base' => 'Represents the response from the server to delete user attributes.
', 'refs' => [], ], 'DeleteUserPoolClientRequest' => [ 'base' => 'Represents the request to delete a user pool client.
', 'refs' => [], ], 'DeleteUserPoolDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserPoolDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserPoolRequest' => [ 'base' => 'Represents the request to delete a user pool.
', 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => 'Represents the request to delete a user.
', 'refs' => [], ], 'DeletionProtectionType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$DeletionProtection' => 'When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". You can specify more than one value.
The method that Amazon Cognito used to send the code.
', 'DeliveryMediumListType$member' => NULL, 'MFAOptionType$DeliveryMedium' => 'The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.
Represents the request to describe the user import job.
', 'refs' => [], ], 'DescribeUserImportJobResponse' => [ 'base' => 'Represents the response from the server to the request to describe the user import job.
', 'refs' => [], ], 'DescribeUserPoolClientRequest' => [ 'base' => 'Represents the request to describe a user pool client.
', 'refs' => [], ], 'DescribeUserPoolClientResponse' => [ 'base' => 'Represents the response from the server from a request to describe the user pool client.
', 'refs' => [], ], 'DescribeUserPoolDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserPoolDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserPoolRequest' => [ 'base' => 'Represents the request to describe the user pool.
', 'refs' => [], ], 'DescribeUserPoolResponse' => [ 'base' => 'Represents the response to describe the user pool.
', 'refs' => [], ], 'DescriptionType' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$Description' => 'A string containing the description of the group.
', 'GroupType$Description' => 'A string containing the description of the group.
', 'UpdateGroupRequest$Description' => 'A string containing the new description of the group.
', ], ], 'DeviceConfigurationType' => [ 'base' => 'The device-remembering configuration for a user pool. A DescribeUserPool request returns a null value for this object when the user pool isn\'t configured to remember devices. When device remembering is active, you can remember a user\'s device with a ConfirmDevice API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt is true, you must follow ConfirmDevice with an UpdateDeviceStatus API request that sets the user\'s device to remembered or not_remembered.
To sign in with a remembered device, include DEVICE_KEY in the authentication parameters in your user\'s InitiateAuth request. If your app doesn\'t include a DEVICE_KEY parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY and DEVICE_GROUP_KEY values under NewDeviceMetadata. Store these values to use in future device-authentication requests.
When you provide a value for any property of DeviceConfiguration, you activate the device remembering for the user pool.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device key.
', 'AdminGetDeviceRequest$DeviceKey' => 'The device key.
', 'AdminUpdateDeviceStatusRequest$DeviceKey' => 'The device key.
', 'ConfirmDeviceRequest$DeviceKey' => 'The device key.
', 'DeviceType$DeviceKey' => 'The device key.
', 'ForgetDeviceRequest$DeviceKey' => 'The device key.
', 'GetDeviceRequest$DeviceKey' => 'The device key.
', 'NewDeviceMetadataType$DeviceKey' => 'The device key.
', 'UpdateDeviceStatusRequest$DeviceKey' => 'The device key.
', ], ], 'DeviceListType' => [ 'base' => NULL, 'refs' => [ 'AdminListDevicesResponse$Devices' => 'The devices in the list of devices response.
', 'ListDevicesResponse$Devices' => 'The devices returned in the list devices response.
', ], ], 'DeviceNameType' => [ 'base' => NULL, 'refs' => [ 'ConfirmDeviceRequest$DeviceName' => 'The device name.
', ], ], 'DeviceRememberedStatusType' => [ 'base' => NULL, 'refs' => [ 'AdminUpdateDeviceStatusRequest$DeviceRememberedStatus' => 'The status indicating whether a device has been remembered or not.
', 'UpdateDeviceStatusRequest$DeviceRememberedStatus' => 'The status of whether a device is remembered.
', ], ], 'DeviceSecretVerifierConfigType' => [ 'base' => 'The device verifier against which it is authenticated.
', 'refs' => [ 'ConfirmDeviceRequest$DeviceSecretVerifierConfig' => 'The configuration of the device secret verifier.
', ], ], 'DeviceType' => [ 'base' => 'The device type.
', 'refs' => [ 'AdminGetDeviceResponse$Device' => 'The device.
', 'DeviceListType$member' => NULL, 'GetDeviceResponse$Device' => 'The device.
', ], ], 'DomainDescriptionType' => [ 'base' => 'A container for information about a domain.
', 'refs' => [ 'DescribeUserPoolDomainResponse$DomainDescription' => 'A domain description object containing information about the domain.
', ], ], 'DomainStatusType' => [ 'base' => NULL, 'refs' => [ 'DomainDescriptionType$Status' => 'The domain status.
', ], ], 'DomainType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolDomainRequest$Domain' => 'The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
', 'DeleteUserPoolDomainRequest$Domain' => 'The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.
This string can include only lowercase letters, numbers, and hyphens. Don\'t use a hyphen for the first or last character. Use periods to separate subdomain names.
', 'UpdateUserPoolDomainResponse$CloudFrontDomain' => 'The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.
', 'UserPoolType$Domain' => 'The domain prefix, if the user pool has a domain associated with it.
', 'UserPoolType$CustomDomain' => 'A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
', ], ], 'DomainVersionType' => [ 'base' => NULL, 'refs' => [ 'DomainDescriptionType$Version' => 'The app version.
', ], ], 'DuplicateProviderException' => [ 'base' => 'This exception is thrown when the provider is already supported by the user pool.
', 'refs' => [], ], 'EmailAddressType' => [ 'base' => NULL, 'refs' => [ 'EmailConfigurationType$ReplyToEmailAddress' => 'The destination to which the receiver of the email should reply.
', ], ], 'EmailConfigurationType' => [ 'base' => 'The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see Email settings for Amazon Cognito user pools.
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
', 'UpdateUserPoolRequest$EmailConfiguration' => 'The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
', 'UserPoolType$EmailConfiguration' => 'The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user pool.
', ], ], 'EmailNotificationBodyType' => [ 'base' => NULL, 'refs' => [ 'NotifyEmailType$HtmlBody' => 'The email HTML body.
', 'NotifyEmailType$TextBody' => 'The email text body.
', ], ], 'EmailNotificationSubjectType' => [ 'base' => NULL, 'refs' => [ 'NotifyEmailType$Subject' => 'The email subject.
', ], ], 'EmailSendingAccountType' => [ 'base' => NULL, 'refs' => [ 'EmailConfigurationType$EmailSendingAccount' => 'Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide.
The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.
Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
This parameter is no longer used. See VerificationMessageTemplateType.
', 'MessageTemplateType$EmailMessage' => 'The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
', 'UpdateUserPoolRequest$EmailVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'UserPoolType$EmailVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'VerificationMessageTemplateType$EmailMessage' => 'The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
This parameter is no longer used. See VerificationMessageTemplateType.
', 'MessageTemplateType$EmailSubject' => 'The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
', 'UpdateUserPoolRequest$EmailVerificationSubject' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'UserPoolType$EmailVerificationSubject' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'VerificationMessageTemplateType$EmailSubject' => 'The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
', 'refs' => [], ], 'EventContextDataType' => [ 'base' => 'Specifies the user context data captured at the time of an event request.
', 'refs' => [ 'AuthEventType$EventContextData' => 'The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.
', ], ], 'EventFeedbackType' => [ 'base' => 'Specifies the event feedback type.
', 'refs' => [ 'AuthEventType$EventFeedback' => 'A flag specifying the user feedback captured at the time of an event request is good or bad.
', ], ], 'EventFilterType' => [ 'base' => NULL, 'refs' => [ 'EventFiltersType$member' => NULL, ], ], 'EventFiltersType' => [ 'base' => NULL, 'refs' => [ 'CompromisedCredentialsRiskConfigurationType$EventFilter' => 'Perform the action for these events. The default is to perform all events if no event filter is specified.
', ], ], 'EventIdType' => [ 'base' => NULL, 'refs' => [ 'AdminUpdateAuthEventFeedbackRequest$EventId' => 'The authentication event ID.
', 'UpdateAuthEventFeedbackRequest$EventId' => 'The event ID.
', ], ], 'EventResponseType' => [ 'base' => NULL, 'refs' => [ 'AuthEventType$EventResponse' => 'The event response.
', ], ], 'EventRiskType' => [ 'base' => 'The event risk type.
', 'refs' => [ 'AuthEventType$EventRisk' => 'The event risk.
', ], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'AuthEventType$EventType' => 'The event type.
', ], ], 'ExpiredCodeException' => [ 'base' => 'This exception is thrown if a code has expired.
', 'refs' => [], ], 'ExplicitAuthFlowsListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$ExplicitAuthFlows' => 'The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don\'t specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can\'t assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don\'t specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can\'t assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don\'t specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can\'t assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
The authentication event feedback value.
', 'EventFeedbackType$FeedbackValue' => 'The event feedback value.
', 'UpdateAuthEventFeedbackRequest$FeedbackValue' => 'The authentication event feedback value.
', ], ], 'ForbiddenException' => [ 'base' => 'This exception is thrown when WAF doesn\'t allow your request based on a web ACL that\'s associated with your user pool.
', 'refs' => [], ], 'ForceAliasCreation' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserRequest$ForceAliasCreation' => 'This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
Represents the request to forget the device.
', 'refs' => [], ], 'ForgotPasswordRequest' => [ 'base' => 'Represents the request to reset a user\'s password.
', 'refs' => [], ], 'ForgotPasswordResponse' => [ 'base' => 'The response from Amazon Cognito to a request to reset a password.
', 'refs' => [], ], 'GenerateSecret' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$GenerateSecret' => 'Boolean to specify whether you want to generate a secret for the user pool client being created.
', ], ], 'GetCSVHeaderRequest' => [ 'base' => 'Represents the request to get the header information of the CSV file for the user import job.
', 'refs' => [], ], 'GetCSVHeaderResponse' => [ 'base' => 'Represents the response from the server to the request to get the header information of the CSV file for the user import job.
', 'refs' => [], ], 'GetDeviceRequest' => [ 'base' => 'Represents the request to get the device.
', 'refs' => [], ], 'GetDeviceResponse' => [ 'base' => 'Gets the device response.
', 'refs' => [], ], 'GetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIdentityProviderByIdentifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIdentityProviderByIdentifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningCertificateRequest' => [ 'base' => 'Request to get a signing certificate from Amazon Cognito.
', 'refs' => [], ], 'GetSigningCertificateResponse' => [ 'base' => 'Response from Amazon Cognito for a signing certificate request.
', 'refs' => [], ], 'GetUICustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUICustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserAttributeVerificationCodeRequest' => [ 'base' => 'Represents the request to get user attribute verification.
', 'refs' => [], ], 'GetUserAttributeVerificationCodeResponse' => [ 'base' => 'The verification code response returned by the server response to get the user attribute verification code.
', 'refs' => [], ], 'GetUserPoolMfaConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserPoolMfaConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserRequest' => [ 'base' => 'Represents the request to get information about the user.
', 'refs' => [], ], 'GetUserResponse' => [ 'base' => 'Represents the response from the server from the request to get information about the user.
', 'refs' => [], ], 'GlobalSignOutRequest' => [ 'base' => 'Represents the request to sign out all devices.
', 'refs' => [], ], 'GlobalSignOutResponse' => [ 'base' => 'The response to the request to sign out all devices.
', 'refs' => [], ], 'GroupExistsException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
', 'refs' => [], ], 'GroupListType' => [ 'base' => NULL, 'refs' => [ 'AdminListGroupsForUserResponse$Groups' => 'The groups that the user belongs to.
', 'ListGroupsResponse$Groups' => 'The group objects for the groups.
', ], ], 'GroupNameType' => [ 'base' => NULL, 'refs' => [ 'AdminAddUserToGroupRequest$GroupName' => 'The group name.
', 'AdminRemoveUserFromGroupRequest$GroupName' => 'The group name.
', 'CreateGroupRequest$GroupName' => 'The name of the group. Must be unique.
', 'DeleteGroupRequest$GroupName' => 'The name of the group.
', 'GetGroupRequest$GroupName' => 'The name of the group.
', 'GroupType$GroupName' => 'The name of the group.
', 'ListUsersInGroupRequest$GroupName' => 'The name of the group.
', 'UpdateGroupRequest$GroupName' => 'The name of the group.
', ], ], 'GroupType' => [ 'base' => 'The group type.
', 'refs' => [ 'CreateGroupResponse$Group' => 'The group object for the group.
', 'GetGroupResponse$Group' => 'The group object for the group.
', 'GroupListType$member' => NULL, 'UpdateGroupResponse$Group' => 'The group object for the group.
', ], ], 'HexStringType' => [ 'base' => NULL, 'refs' => [ 'AnalyticsConfigurationType$ApplicationId' => 'The application ID for an Amazon Pinpoint application.
', ], ], 'HttpHeader' => [ 'base' => 'The HTTP header.
', 'refs' => [ 'HttpHeaderList$member' => NULL, ], ], 'HttpHeaderList' => [ 'base' => NULL, 'refs' => [ 'ContextDataType$HttpHeaders' => 'HttpHeaders received on your server in same order.
', ], ], 'IdTokenValidityType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$IdTokenValidity' => 'The ID token time limit. After this limit expires, your user can\'t use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
', 'UpdateUserPoolClientRequest$IdTokenValidity' => 'The ID token time limit. After this limit expires, your user can\'t use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
', 'UserPoolClientType$IdTokenValidity' => 'The ID token time limit. After this limit expires, your user can\'t use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
', ], ], 'IdentityProviderType' => [ 'base' => 'A container for information about an IdP.
', 'refs' => [ 'CreateIdentityProviderResponse$IdentityProvider' => 'The newly created IdP object.
', 'DescribeIdentityProviderResponse$IdentityProvider' => 'The identity provider details.
', 'GetIdentityProviderByIdentifierResponse$IdentityProvider' => 'The identity provider details.
', 'UpdateIdentityProviderResponse$IdentityProvider' => 'The identity provider details.
', ], ], 'IdentityProviderTypeType' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$ProviderType' => 'The IdP type.
', 'IdentityProviderType$ProviderType' => 'The IdP type.
', 'ProviderDescription$ProviderType' => 'The IdP type.
', ], ], 'IdpIdentifierType' => [ 'base' => NULL, 'refs' => [ 'GetIdentityProviderByIdentifierRequest$IdpIdentifier' => 'The IdP identifier.
', 'IdpIdentifiersListType$member' => NULL, ], ], 'IdpIdentifiersListType' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$IdpIdentifiers' => 'A list of IdP identifiers.
', 'IdentityProviderType$IdpIdentifiers' => 'A list of IdP identifiers.
', 'UpdateIdentityProviderRequest$IdpIdentifiers' => 'A list of IdP identifiers.
', ], ], 'ImageFileType' => [ 'base' => NULL, 'refs' => [ 'SetUICustomizationRequest$ImageFile' => 'The uploaded logo image for the UI customization.
', ], ], 'ImageUrlType' => [ 'base' => NULL, 'refs' => [ 'UICustomizationType$ImageUrl' => 'The logo image for the UI customization.
', ], ], 'InitiateAuthRequest' => [ 'base' => 'Initiates the authentication request.
', 'refs' => [], ], 'InitiateAuthResponse' => [ 'base' => 'Initiates the authentication response.
', 'refs' => [], ], 'IntegerType' => [ 'base' => NULL, 'refs' => [ 'AuthenticationResultType$ExpiresIn' => 'The expiration period of the authentication result in seconds.
', 'UserPoolType$EstimatedNumberOfUsers' => 'A number estimating the size of the user pool.
', ], ], 'InternalErrorException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters an internal error.
', 'refs' => [], ], 'InvalidEmailRoleAccessPolicyException' => [ 'base' => 'This exception is thrown when Amazon Cognito isn\'t allowed to use your email identity. HTTP status code: 400.
', 'refs' => [], ], 'InvalidLambdaResponseException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
', 'refs' => [], ], 'InvalidOAuthFlowException' => [ 'base' => 'This exception is thrown when the specified OAuth flow is not valid.
', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => 'This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
', 'refs' => [], ], 'InvalidPasswordException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters an invalid password.
', 'refs' => [], ], 'InvalidSmsRoleAccessPolicyException' => [ 'base' => 'This exception is returned when the role provided for SMS configuration doesn\'t have permission to publish using Amazon SNS.
', 'refs' => [], ], 'InvalidSmsRoleTrustRelationshipException' => [ 'base' => 'This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don\'t trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
This exception is thrown when the user pool configuration is not valid.
', 'refs' => [], ], 'LambdaConfigType' => [ 'base' => 'Specifies the configuration for Lambda triggers.
', 'refs' => [ 'CreateUserPoolRequest$LambdaConfig' => 'The Lambda trigger configuration information for the new user pool.
In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
For more information on using the Lambda API to add permission, see AddPermission .
For adding permission using the CLI, see add-permission .
The Lambda configuration information from the request to update the user pool.
', 'UserPoolDescriptionType$LambdaConfig' => 'The Lambda configuration information in a user pool description.
', 'UserPoolType$LambdaConfig' => 'The Lambda triggers associated with the user pool.
', ], ], 'LimitExceededException' => [ 'base' => 'This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
', 'refs' => [], ], 'ListDevicesRequest' => [ 'base' => 'Represents the request to list the devices.
', 'refs' => [], ], 'ListDevicesResponse' => [ 'base' => 'Represents the response to list devices.
', 'refs' => [], ], 'ListGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityProvidersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityProvidersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListOfStringTypes' => [ 'base' => NULL, 'refs' => [ 'GetCSVHeaderResponse$CSVHeader' => 'The header information of the CSV file for the user import job.
', ], ], 'ListProvidersLimitType' => [ 'base' => NULL, 'refs' => [ 'ListIdentityProvidersRequest$MaxResults' => 'The maximum number of IdPs to return.
', ], ], 'ListResourceServersLimitType' => [ 'base' => NULL, 'refs' => [ 'ListResourceServersRequest$MaxResults' => 'The maximum number of resource servers to return.
', ], ], 'ListResourceServersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceServersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserImportJobsRequest' => [ 'base' => 'Represents the request to list the user import jobs.
', 'refs' => [], ], 'ListUserImportJobsResponse' => [ 'base' => 'Represents the response from the server to the request to list the user import jobs.
', 'refs' => [], ], 'ListUserPoolClientsRequest' => [ 'base' => 'Represents the request to list the user pool clients.
', 'refs' => [], ], 'ListUserPoolClientsResponse' => [ 'base' => 'Represents the response from the server that lists user pool clients.
', 'refs' => [], ], 'ListUserPoolsRequest' => [ 'base' => 'Represents the request to list user pools.
', 'refs' => [], ], 'ListUserPoolsResponse' => [ 'base' => 'Represents the response to list user pools.
', 'refs' => [], ], 'ListUsersInGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersInGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => 'Represents the request to list users.
', 'refs' => [], ], 'ListUsersResponse' => [ 'base' => 'The response from the request to list users.
', 'refs' => [], ], 'LogoutURLsListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$LogoutURLs' => 'A list of allowed logout URLs for the IdPs.
', 'UpdateUserPoolClientRequest$LogoutURLs' => 'A list of allowed logout URLs for the IdPs.
', 'UserPoolClientType$LogoutURLs' => 'A list of allowed logout URLs for the IdPs.
', ], ], 'LongType' => [ 'base' => NULL, 'refs' => [ 'UserImportJobType$ImportedUsers' => 'The number of users that were successfully imported.
', 'UserImportJobType$SkippedUsers' => 'The number of users that were skipped.
', 'UserImportJobType$FailedUsers' => 'The number of users that couldn\'t be imported.
', ], ], 'MFAMethodNotFoundException' => [ 'base' => 'This exception is thrown when Amazon Cognito can\'t find a multi-factor authentication (MFA) method.
', 'refs' => [], ], 'MFAOptionListType' => [ 'base' => NULL, 'refs' => [ 'AdminGetUserResponse$MFAOptions' => 'This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn\'t provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
', 'AdminSetUserSettingsRequest$MFAOptions' => 'You can use this parameter only to set an SMS configuration that uses SMS for delivery.
', 'GetUserResponse$MFAOptions' => 'This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn\'t provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
', 'SetUserSettingsRequest$MFAOptions' => 'You can use this parameter only to set an SMS configuration that uses SMS for delivery.
', 'UserType$MFAOptions' => 'The MFA options for the user.
', ], ], 'MFAOptionType' => [ 'base' => 'This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.
', 'refs' => [ 'MFAOptionListType$member' => NULL, ], ], 'MessageActionType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserRequest$MessageAction' => 'Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user\'s account. Set to SUPPRESS to suppress sending the message. You can specify only one value.
The message template structure.
', 'refs' => [ 'AdminCreateUserConfigType$InviteMessageTemplate' => 'The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
', ], ], 'MessageType' => [ 'base' => NULL, 'refs' => [ 'AliasExistsException$message' => 'The message that Amazon Cognito sends to the user when the value of an alias attribute is already linked to another user profile.
', 'CodeDeliveryFailureException$message' => 'The message sent when a verification code fails to deliver successfully.
', 'CodeMismatchException$message' => 'The message provided when the code mismatch exception is thrown.
', 'ConcurrentModificationException$message' => 'The message provided when the concurrent exception is thrown.
', 'DuplicateProviderException$message' => NULL, 'EnableSoftwareTokenMFAException$message' => NULL, 'ExpiredCodeException$message' => 'The message returned when the expired code exception is thrown.
', 'ForbiddenException$message' => 'The message returned when WAF doesn\'t allow your request based on a web ACL that\'s associated with your user pool.
', 'GroupExistsException$message' => NULL, 'InternalErrorException$message' => 'The message returned when Amazon Cognito throws an internal error exception.
', 'InvalidEmailRoleAccessPolicyException$message' => 'The message returned when you have an unverified email address or the identity policy isn\'t set on an email address that Amazon Cognito can access.
', 'InvalidLambdaResponseException$message' => 'The message returned when Amazon Cognito throws an invalid Lambda response exception.
', 'InvalidOAuthFlowException$message' => NULL, 'InvalidParameterException$message' => 'The message returned when the Amazon Cognito service throws an invalid parameter exception.
', 'InvalidPasswordException$message' => 'The message returned when Amazon Cognito throws an invalid user password exception.
', 'InvalidSmsRoleAccessPolicyException$message' => 'The message returned when the invalid SMS role access policy exception is thrown.
', 'InvalidSmsRoleTrustRelationshipException$message' => 'The message returned when the role trust relationship for the SMS message is not valid.
', 'InvalidUserPoolConfigurationException$message' => 'The message returned when the user pool configuration is not valid.
', 'LimitExceededException$message' => 'The message returned when Amazon Cognito throws a limit exceeded exception.
', 'MFAMethodNotFoundException$message' => 'The message returned when Amazon Cognito throws an MFA method not found exception.
', 'NotAuthorizedException$message' => 'The message returned when the Amazon Cognito service returns a not authorized exception.
', 'PasswordResetRequiredException$message' => 'The message returned when a password reset is required.
', 'PreconditionNotMetException$message' => 'The message returned when a precondition is not met.
', 'ResourceNotFoundException$message' => 'The message returned when the Amazon Cognito service returns a resource not found exception.
', 'ScopeDoesNotExistException$message' => NULL, 'SoftwareTokenMFANotFoundException$message' => NULL, 'TooManyFailedAttemptsException$message' => 'The message returned when Amazon Cognito returns a TooManyFailedAttempts exception.
The message returned when the Amazon Cognito service returns a too many requests exception.
', 'UnauthorizedException$message' => NULL, 'UnexpectedLambdaException$message' => 'The message returned when Amazon Cognito returns an unexpected Lambda exception.
', 'UnsupportedIdentityProviderException$message' => NULL, 'UnsupportedOperationException$message' => NULL, 'UnsupportedTokenTypeException$message' => NULL, 'UnsupportedUserStateException$message' => 'The message returned when the user is in an unsupported state.
', 'UserImportInProgressException$message' => 'The message returned when the user pool has an import job running.
', 'UserLambdaValidationException$message' => 'The message returned when the Amazon Cognito service returns a user validation exception with the Lambda service.
', 'UserNotConfirmedException$message' => 'The message returned when a user isn\'t confirmed successfully.
', 'UserNotFoundException$message' => 'The message returned when a user isn\'t found.
', 'UserPoolAddOnNotEnabledException$message' => NULL, 'UserPoolTaggingException$message' => NULL, 'UsernameExistsException$message' => 'The message returned when Amazon Cognito throws a user name exists exception.
', ], ], 'NewDeviceMetadataType' => [ 'base' => 'The new device metadata type.
', 'refs' => [ 'AuthenticationResultType$NewDeviceMetadata' => 'The new device metadata from an authentication result.
', ], ], 'NotAuthorizedException' => [ 'base' => 'This exception is thrown when a user isn\'t authorized.
', 'refs' => [], ], 'NotifyConfigurationType' => [ 'base' => 'The notify configuration type.
', 'refs' => [ 'AccountTakeoverRiskConfigurationType$NotifyConfiguration' => 'The notify configuration used to construct email notifications.
', ], ], 'NotifyEmailType' => [ 'base' => 'The notify email type.
', 'refs' => [ 'NotifyConfigurationType$BlockEmail' => 'Email template used when a detected risk event is blocked.
', 'NotifyConfigurationType$NoActionEmail' => 'The email template used when a detected risk event is allowed.
', 'NotifyConfigurationType$MfaEmail' => 'The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.
', ], ], 'NumberAttributeConstraintsType' => [ 'base' => 'The minimum and maximum values of an attribute that is of the number data type.
', 'refs' => [ 'SchemaAttributeType$NumberAttributeConstraints' => 'Specifies the constraints for an attribute of the number type.
', ], ], 'OAuthFlowType' => [ 'base' => NULL, 'refs' => [ 'OAuthFlowsType$member' => NULL, ], ], 'OAuthFlowsType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$AllowedOAuthFlows' => 'The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'AdminListGroupsForUserResponse$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'AdminListUserAuthEventsRequest$NextToken' => 'A pagination token.
', 'AdminListUserAuthEventsResponse$NextToken' => 'A pagination token.
', 'ListGroupsRequest$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListGroupsResponse$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUserPoolClientsRequest$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUserPoolClientsResponse$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUsersInGroupRequest$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUsersInGroupResponse$NextToken' => 'An identifier that you can use in a later request to return the next set of items in the list.
', ], ], 'PaginationKeyType' => [ 'base' => NULL, 'refs' => [ 'ListIdentityProvidersRequest$NextToken' => 'A pagination token.
', 'ListIdentityProvidersResponse$NextToken' => 'A pagination token.
', 'ListResourceServersRequest$NextToken' => 'A pagination token.
', 'ListResourceServersResponse$NextToken' => 'A pagination token.
', 'ListUserImportJobsRequest$PaginationToken' => 'An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.
An identifier that can be used to return the next set of user import jobs in the list.
', 'ListUserPoolsRequest$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUserPoolsResponse$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', ], ], 'PasswordPolicyMinLengthType' => [ 'base' => NULL, 'refs' => [ 'PasswordPolicyType$MinimumLength' => 'The minimum length of the password in the policy that you have set. This value can\'t be less than 6.
', ], ], 'PasswordPolicyType' => [ 'base' => 'The password policy type.
', 'refs' => [ 'UserPoolPolicyType$PasswordPolicy' => 'The password policy.
', ], ], 'PasswordResetRequiredException' => [ 'base' => 'This exception is thrown when a password reset is required.
', 'refs' => [], ], 'PasswordType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserRequest$TemporaryPassword' => 'The user\'s temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn\'t required. If you don\'t specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
The password for the user.
', 'ChangePasswordRequest$PreviousPassword' => 'The old password.
', 'ChangePasswordRequest$ProposedPassword' => 'The new password.
', 'ConfirmForgotPasswordRequest$Password' => 'The new password that your user wants to set.
', 'SignUpRequest$Password' => 'The password of the user you want to register.
', ], ], 'PoolQueryLimitType' => [ 'base' => NULL, 'refs' => [ 'ListUserImportJobsRequest$MaxResults' => 'The maximum number of import jobs you want the request to return.
', 'ListUserPoolsRequest$MaxResults' => 'The maximum number of results you want the request to return when listing the user pools.
', ], ], 'PreSignedUrlType' => [ 'base' => NULL, 'refs' => [ 'UserImportJobType$PreSignedUrl' => 'The pre-signed URL to be used to upload the .csv file.
A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user\'s tokens for the cognito:roles and cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn\'t set in users\' tokens.
The default Precedence value is null. The maximum Precedence value is 2^31-1.
A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher ornull Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user\'s tokens for the cognito:roles and cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn\'t set in users\' tokens.
The default Precedence value is null.
The new precedence value for the group. For more information about this parameter, see CreateGroup.
', ], ], 'PreconditionNotMetException' => [ 'base' => 'This exception is thrown when a precondition is not met.
', 'refs' => [], ], 'PreventUserExistenceErrorTypes' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$PreventUserExistenceErrors' => 'Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn\'t exist in the user pool. When set to ENABLED and the user doesn\'t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn\'t exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren\'t prevented.
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn\'t exist in the user pool. When set to ENABLED and the user doesn\'t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn\'t exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren\'t prevented.
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn\'t exist in the user pool. When set to ENABLED and the user doesn\'t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn\'t exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren\'t prevented.
A positive integer specifying priority of a method with 1 being the highest priority.
', ], ], 'ProviderDescription' => [ 'base' => 'A container for IdP details.
', 'refs' => [ 'ProvidersListType$member' => NULL, ], ], 'ProviderDetailsType' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$ProviderDetails' => 'The IdP details. The following list describes the provider detail keys for each IdP type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OpenID Connect (OIDC) providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
The following keys are only present if Amazon Cognito didn\'t discover them at the oidc_issuer URL.
authorize_url
token_url
attributes_url
jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
attributes_url_add_attributes
For SAML providers:
MetadataFile or MetadataURL
IDPSignout optional
The IdP details. The following list describes the provider detail keys for each IdP type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
You can submit a private_key when you add or update an IdP. Describe operations don\'t return the private key.
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
The following keys are only present if Amazon Cognito didn\'t discover them at the oidc_issuer URL.
authorize_url
token_url
attributes_url
jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
attributes_url_add_attributes
For SAML providers:
MetadataFile or MetadataURL
IDPSignout optional
The IdP details to be updated, such as MetadataURL and MetadataFile.
The IdP name.
', 'DescribeIdentityProviderRequest$ProviderName' => 'The IdP name.
', 'IdentityProviderType$ProviderName' => 'The IdP name.
', 'ProviderDescription$ProviderName' => 'The IdP name.
', 'ProviderUserIdentifierType$ProviderName' => 'The name of the provider, such as Facebook, Google, or Login with Amazon.
', 'SupportedIdentityProvidersListType$member' => NULL, 'UpdateIdentityProviderRequest$ProviderName' => 'The IdP name.
', ], ], 'ProviderNameTypeV1' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$ProviderName' => 'The IdP name.
', ], ], 'ProviderUserIdentifierType' => [ 'base' => 'A container for information about an IdP for a user pool.
', 'refs' => [ 'AdminDisableProviderForUserRequest$User' => 'The user to be disabled.
', 'AdminLinkProviderForUserRequest$DestinationUser' => 'The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn\'t exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.
For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.
The ProviderAttributeName of the DestinationUser is ignored.
The ProviderName should be set to Cognito for users in Cognito user pools.
All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won\'t succeed.
An external IdP account for a user who doesn\'t exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
If the SourceUser is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social IdP token.
For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.
A list of IdP objects.
', ], ], 'QueryLimit' => [ 'base' => NULL, 'refs' => [ 'ListUserPoolClientsRequest$MaxResults' => 'The maximum number of results you want the request to return when listing the user pool clients.
', ], ], 'QueryLimitType' => [ 'base' => NULL, 'refs' => [ 'AdminListDevicesRequest$Limit' => 'The limit of the devices request.
', 'AdminListGroupsForUserRequest$Limit' => 'The limit of the request to list groups.
', 'AdminListUserAuthEventsRequest$MaxResults' => 'The maximum number of authentication events to return. Returns 60 events if you set MaxResults to 0, or if you don\'t include a MaxResults parameter.
The limit of the device request.
', 'ListGroupsRequest$Limit' => 'The limit of the request to list groups.
', 'ListUsersInGroupRequest$Limit' => 'The limit of the request to list users.
', 'ListUsersRequest$Limit' => 'Maximum number of users to be returned.
', ], ], 'RecoveryMechanismsType' => [ 'base' => NULL, 'refs' => [ 'AccountRecoverySettingType$RecoveryMechanisms' => 'The list of RecoveryOptionTypes.
The recovery method for a user.
', ], ], 'RecoveryOptionType' => [ 'base' => 'A map containing a priority as a key, and recovery method name as a value.
', 'refs' => [ 'RecoveryMechanismsType$member' => NULL, ], ], 'RedirectUrlType' => [ 'base' => NULL, 'refs' => [ 'CallbackURLsListType$member' => NULL, 'CreateUserPoolClientRequest$DefaultRedirectURI' => 'The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
', 'LogoutURLsListType$member' => NULL, 'UpdateUserPoolClientRequest$DefaultRedirectURI' => 'The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
', ], ], 'RefreshTokenValidityType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$RefreshTokenValidity' => 'The refresh token time limit. After this limit expires, your user can\'t use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. You can\'t set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
', 'UpdateUserPoolClientRequest$RefreshTokenValidity' => 'The refresh token time limit. After this limit expires, your user can\'t use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. You can\'t set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
', 'UserPoolClientType$RefreshTokenValidity' => 'The refresh token time limit. After this limit expires, your user can\'t use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. You can\'t set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
', ], ], 'RegionCodeType' => [ 'base' => NULL, 'refs' => [ 'SmsConfigurationType$SnsRegion' => 'The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.
Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
', ], ], 'ResendConfirmationCodeRequest' => [ 'base' => 'Represents the request to resend the confirmation code.
', 'refs' => [], ], 'ResendConfirmationCodeResponse' => [ 'base' => 'The response from the server when Amazon Cognito makes the request to resend a confirmation code.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'This exception is thrown when the Amazon Cognito service can\'t find the requested resource.
', 'refs' => [], ], 'ResourceServerIdentifierType' => [ 'base' => NULL, 'refs' => [ 'CreateResourceServerRequest$Identifier' => 'A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.
The identifier for the resource server.
', 'DescribeResourceServerRequest$Identifier' => 'The identifier for the resource server
', 'ResourceServerType$Identifier' => 'The identifier for the resource server.
', 'UpdateResourceServerRequest$Identifier' => 'The identifier for the resource server.
', ], ], 'ResourceServerNameType' => [ 'base' => NULL, 'refs' => [ 'CreateResourceServerRequest$Name' => 'A friendly name for the resource server.
', 'ResourceServerType$Name' => 'The name of the resource server.
', 'UpdateResourceServerRequest$Name' => 'The name of the resource server.
', ], ], 'ResourceServerScopeDescriptionType' => [ 'base' => NULL, 'refs' => [ 'ResourceServerScopeType$ScopeDescription' => 'A description of the scope.
', ], ], 'ResourceServerScopeListType' => [ 'base' => NULL, 'refs' => [ 'CreateResourceServerRequest$Scopes' => 'A list of scopes. Each scope is a key-value map with the keys name and description.
A list of scopes that are defined for the resource server.
', 'UpdateResourceServerRequest$Scopes' => 'The scope values to be set for the resource server.
', ], ], 'ResourceServerScopeNameType' => [ 'base' => NULL, 'refs' => [ 'ResourceServerScopeType$ScopeName' => 'The name of the scope.
', ], ], 'ResourceServerScopeType' => [ 'base' => 'A resource server scope.
', 'refs' => [ 'ResourceServerScopeListType$member' => NULL, ], ], 'ResourceServerType' => [ 'base' => 'A container for information about a resource server for a user pool.
', 'refs' => [ 'CreateResourceServerResponse$ResourceServer' => 'The newly created resource server.
', 'DescribeResourceServerResponse$ResourceServer' => 'The resource server.
', 'ResourceServersListType$member' => NULL, 'UpdateResourceServerResponse$ResourceServer' => 'The resource server.
', ], ], 'ResourceServersListType' => [ 'base' => NULL, 'refs' => [ 'ListResourceServersResponse$ResourceServers' => 'The resource servers.
', ], ], 'RespondToAuthChallengeRequest' => [ 'base' => 'The request to respond to an authentication challenge.
', 'refs' => [], ], 'RespondToAuthChallengeResponse' => [ 'base' => 'The response to respond to the authentication challenge.
', 'refs' => [], ], 'RevokeTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeTokenResponse' => [ 'base' => NULL, 'refs' => [], ], 'RiskConfigurationType' => [ 'base' => 'The risk configuration type.
', 'refs' => [ 'DescribeRiskConfigurationResponse$RiskConfiguration' => 'The risk configuration.
', 'SetRiskConfigurationResponse$RiskConfiguration' => 'The risk configuration.
', ], ], 'RiskDecisionType' => [ 'base' => NULL, 'refs' => [ 'EventRiskType$RiskDecision' => 'The risk decision.
', ], ], 'RiskExceptionConfigurationType' => [ 'base' => 'The type of the configuration to override the risk decision.
', 'refs' => [ 'RiskConfigurationType$RiskExceptionConfiguration' => 'The configuration to override the risk decision.
', 'SetRiskConfigurationRequest$RiskExceptionConfiguration' => 'The configuration to override the risk decision.
', ], ], 'RiskLevelType' => [ 'base' => NULL, 'refs' => [ 'EventRiskType$RiskLevel' => 'The risk level.
', ], ], 'S3BucketType' => [ 'base' => NULL, 'refs' => [ 'DomainDescriptionType$S3Bucket' => 'The Amazon S3 bucket where the static files for this domain are stored.
', ], ], 'SESConfigurationSet' => [ 'base' => NULL, 'refs' => [ 'EmailConfigurationType$ConfigurationSet' => 'The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:
Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don\'t need to be verified to be used for SMS MFA. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
', 'refs' => [ 'AdminSetUserMFAPreferenceRequest$SMSMfaSettings' => 'The SMS text message MFA settings.
', 'SetUserMFAPreferenceRequest$SMSMfaSettings' => 'The SMS text message multi-factor authentication (MFA) settings.
', ], ], 'SchemaAttributeType' => [ 'base' => 'Contains information about the schema attribute.
', 'refs' => [ 'CustomAttributesListType$member' => NULL, 'SchemaAttributesListType$member' => NULL, ], ], 'SchemaAttributesListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$Schema' => 'An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
', 'UserPoolType$SchemaAttributes' => 'A container with the schema attributes of a user pool.
', ], ], 'ScopeDoesNotExistException' => [ 'base' => 'This exception is thrown when the specified scope doesn\'t exist.
', 'refs' => [], ], 'ScopeListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$AllowedOAuthScopes' => 'The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
The pagination token.
', 'AdminListDevicesResponse$PaginationToken' => 'The pagination token.
', 'ListDevicesRequest$PaginationToken' => 'The pagination token for the list request.
', 'ListDevicesResponse$PaginationToken' => 'The pagination token for the list device response.
', 'ListUsersRequest$PaginationToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUsersResponse$PaginationToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', ], ], 'SearchedAttributeNamesListType' => [ 'base' => NULL, 'refs' => [ 'ListUsersRequest$AttributesToGet' => 'An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
', ], ], 'SecretCodeType' => [ 'base' => NULL, 'refs' => [ 'AssociateSoftwareTokenResponse$SecretCode' => 'A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.
', ], ], 'SecretHashType' => [ 'base' => NULL, 'refs' => [ 'ConfirmForgotPasswordRequest$SecretHash' => 'A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
', 'ConfirmSignUpRequest$SecretHash' => 'A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
', 'ForgotPasswordRequest$SecretHash' => 'A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
', 'ResendConfirmationCodeRequest$SecretHash' => 'A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
', 'SignUpRequest$SecretHash' => 'A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
', ], ], 'SessionType' => [ 'base' => NULL, 'refs' => [ 'AdminInitiateAuthResponse$Session' => 'The session that should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
', 'AssociateSoftwareTokenResponse$Session' => 'The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
', 'InitiateAuthResponse$Session' => 'The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service.
', 'VerifySoftwareTokenResponse$Session' => 'The session that should be passed both ways in challenge-response calls to the service.
', ], ], 'SetRiskConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetRiskConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'SetUICustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetUICustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'SetUserMFAPreferenceRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetUserMFAPreferenceResponse' => [ 'base' => NULL, 'refs' => [], ], 'SetUserPoolMfaConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetUserPoolMfaConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'SetUserSettingsRequest' => [ 'base' => 'Represents the request to set user settings.
', 'refs' => [], ], 'SetUserSettingsResponse' => [ 'base' => 'The response from the server for a set user settings request.
', 'refs' => [], ], 'SignUpRequest' => [ 'base' => 'Represents the request to register a user.
', 'refs' => [], ], 'SignUpResponse' => [ 'base' => 'The response from the server for a registration request.
', 'refs' => [], ], 'SkippedIPRangeListType' => [ 'base' => NULL, 'refs' => [ 'RiskExceptionConfigurationType$SkippedIPRangeList' => 'Risk detection isn\'t performed on the IP addresses in this range list. The IP range is in CIDR notation.
', ], ], 'SmsConfigurationType' => [ 'base' => 'The SMS configuration type is the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
', 'refs' => [ 'CreateUserPoolRequest$SmsConfiguration' => 'The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
', 'SmsMfaConfigType$SmsConfiguration' => 'The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.
', 'UpdateUserPoolRequest$SmsConfiguration' => 'The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
', 'UserPoolType$SmsConfiguration' => 'The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
', ], ], 'SmsMfaConfigType' => [ 'base' => 'The SMS text message multi-factor authentication (MFA) configuration type.
', 'refs' => [ 'GetUserPoolMfaConfigResponse$SmsMfaConfiguration' => 'The SMS text message multi-factor authentication (MFA) configuration.
', 'SetUserPoolMfaConfigRequest$SmsMfaConfiguration' => 'The SMS text message MFA configuration.
', 'SetUserPoolMfaConfigResponse$SmsMfaConfiguration' => 'The SMS text message MFA configuration.
', ], ], 'SmsVerificationMessageType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$SmsVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'CreateUserPoolRequest$SmsAuthenticationMessage' => 'A string representing the SMS authentication message.
', 'MessageTemplateType$SMSMessage' => 'The message template for SMS messages.
', 'SmsMfaConfigType$SmsAuthenticationMessage' => 'The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn\'t included, and default message will be used.
', 'UpdateUserPoolRequest$SmsVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'UpdateUserPoolRequest$SmsAuthenticationMessage' => 'The contents of the SMS authentication message.
', 'UserPoolType$SmsVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'UserPoolType$SmsAuthenticationMessage' => 'The contents of the SMS authentication message.
', 'VerificationMessageTemplateType$SmsMessage' => 'The template for SMS messages that Amazon Cognito sends to your users.
', ], ], 'SoftwareTokenMFANotFoundException' => [ 'base' => 'This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn\'t activated for the user pool.
', 'refs' => [], ], 'SoftwareTokenMFAUserCodeType' => [ 'base' => NULL, 'refs' => [ 'VerifySoftwareTokenRequest$UserCode' => 'The one- time password computed using the secret code returned by AssociateSoftwareToken.
', ], ], 'SoftwareTokenMfaConfigType' => [ 'base' => 'The type used for enabling software token MFA at the user pool level.
', 'refs' => [ 'GetUserPoolMfaConfigResponse$SoftwareTokenMfaConfiguration' => 'The software token multi-factor authentication (MFA) configuration.
', 'SetUserPoolMfaConfigRequest$SoftwareTokenMfaConfiguration' => 'The software token MFA configuration.
', 'SetUserPoolMfaConfigResponse$SoftwareTokenMfaConfiguration' => 'The software token MFA configuration.
', ], ], 'SoftwareTokenMfaSettingsType' => [ 'base' => 'The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
', 'refs' => [ 'AdminSetUserMFAPreferenceRequest$SoftwareTokenMfaSettings' => 'The time-based one-time password software token MFA settings.
', 'SetUserMFAPreferenceRequest$SoftwareTokenMfaSettings' => 'The time-based one-time password (TOTP) software token MFA settings.
', ], ], 'StartUserImportJobRequest' => [ 'base' => 'Represents the request to start the user import job.
', 'refs' => [], ], 'StartUserImportJobResponse' => [ 'base' => 'Represents the response from the server to the request to start the user import job.
', 'refs' => [], ], 'StatusType' => [ 'base' => NULL, 'refs' => [ 'UserPoolDescriptionType$Status' => 'The user pool status in a user pool description.
', 'UserPoolType$Status' => 'The status of a user pool.
', ], ], 'StopUserImportJobRequest' => [ 'base' => 'Represents the request to stop the user import job.
', 'refs' => [], ], 'StopUserImportJobResponse' => [ 'base' => 'Represents the response from the server to the request to stop the user import job.
', 'refs' => [], ], 'StringAttributeConstraintsType' => [ 'base' => 'The constraints associated with a string attribute.
', 'refs' => [ 'SchemaAttributeType$StringAttributeConstraints' => 'Specifies the constraints for an attribute of the string type.
', ], ], 'StringType' => [ 'base' => NULL, 'refs' => [ 'AdminDisableProviderForUserRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AdminGetUserResponse$PreferredMfaSetting' => 'The user\'s preferred MFA setting.
', 'AdminLinkProviderForUserRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AnalyticsConfigurationType$ExternalId' => 'The external ID.
', 'AnalyticsMetadataType$AnalyticsEndpointId' => 'The endpoint ID.
', 'AttributeMappingType$value' => NULL, 'AuthEventType$EventId' => 'The event ID.
', 'AuthParametersType$key' => NULL, 'AuthParametersType$value' => NULL, 'AuthenticationResultType$TokenType' => 'The token type.
', 'BlockedIPRangeListType$member' => NULL, 'ChallengeParametersType$key' => NULL, 'ChallengeParametersType$value' => NULL, 'ChallengeResponsesType$key' => NULL, 'ChallengeResponsesType$value' => NULL, 'ClientMetadataType$key' => NULL, 'ClientMetadataType$value' => NULL, 'CodeDeliveryDetailsType$Destination' => 'The email address or phone number destination where Amazon Cognito sent the code.
', 'ContextDataType$IpAddress' => 'The source IP address of your user\'s device.
', 'ContextDataType$ServerName' => 'Your server endpoint where this API is invoked.
', 'ContextDataType$ServerPath' => 'Your server path where this API is invoked.
', 'ContextDataType$EncodedData' => 'Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
', 'DeviceSecretVerifierConfigType$PasswordVerifier' => 'The password verifier.
', 'DeviceSecretVerifierConfigType$Salt' => 'The salt
', 'DomainDescriptionType$CloudFrontDistribution' => 'The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
', 'EmailConfigurationType$From' => 'Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.
The source IP address of your user\'s device.
', 'EventContextDataType$DeviceName' => 'The user\'s device name.
', 'EventContextDataType$Timezone' => 'The user\'s time zone.
', 'EventContextDataType$City' => 'The user\'s city.
', 'EventContextDataType$Country' => 'The user\'s country.
', 'EventFeedbackType$Provider' => 'The provider.
', 'GetSigningCertificateResponse$Certificate' => 'The signing certificate.
', 'GetUserResponse$PreferredMfaSetting' => 'The user\'s preferred MFA setting.
', 'HttpHeader$headerName' => 'The header name.
', 'HttpHeader$headerValue' => 'The header value.
', 'ListOfStringTypes$member' => NULL, 'NewDeviceMetadataType$DeviceGroupKey' => 'The device group key.
', 'NotifyConfigurationType$From' => 'The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
', 'NotifyConfigurationType$ReplyTo' => 'The destination to which the receiver of an email should reply to.
', 'NumberAttributeConstraintsType$MinValue' => 'The minimum value of an attribute that is of the number data type.
', 'NumberAttributeConstraintsType$MaxValue' => 'The maximum value of an attribute that is of the number data type.
', 'ProviderDetailsType$key' => NULL, 'ProviderDetailsType$value' => NULL, 'ProviderUserIdentifierType$ProviderAttributeName' => 'The name of the provider attribute to link to, such as NameID.
The value of the provider attribute to link to, such as xxxxx_account.
The UUID of the authenticated user. This isn\'t the same as username.
The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.
For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party
The minimum length.
', 'StringAttributeConstraintsType$MaxLength' => 'The maximum length.
', 'UserContextDataType$IpAddress' => 'The source IP address of your user\'s device.
', 'UserContextDataType$EncodedData' => 'Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
', 'UserMFASettingListType$member' => NULL, 'UserPoolType$SmsConfigurationFailure' => 'The reason why the SMS configuration can\'t send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can\'t send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn\'t properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.
The friendly device name.
', ], ], 'SupportedIdentityProvidersListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$SupportedIdentityProviders' => 'A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.
A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.
A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.
The number of days a temporary password is valid in the password policy. If the user doesn\'t sign in during this time, an administrator must reset their password.
When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.
A time unit of seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours.
A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours.
A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days.
A valid access token that Amazon Cognito issued to the user whose software token you want to generate.
', 'AuthenticationResultType$AccessToken' => 'A valid access token that Amazon Cognito issued to the user who you want to authenticate.
', 'AuthenticationResultType$RefreshToken' => 'The refresh token.
', 'AuthenticationResultType$IdToken' => 'The ID token.
', 'ChangePasswordRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose password you want to change.
', 'ConfirmDeviceRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
', 'DeleteUserAttributesRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
', 'DeleteUserRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.
', 'ForgetDeviceRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.
', 'GetDeviceRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose device information you want to request.
', 'GetUserAttributeVerificationCodeRequest$AccessToken' => 'A non-expired access token for the user whose attribute verification code you want to generate.
', 'GetUserRequest$AccessToken' => 'A non-expired access token for the user whose information you want to query.
', 'GlobalSignOutRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user who you want to sign out.
', 'ListDevicesRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
', 'RevokeTokenRequest$Token' => 'The refresh token that you want to revoke.
', 'SetUserMFAPreferenceRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
', 'SetUserSettingsRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
', 'UpdateAuthEventFeedbackRequest$FeedbackToken' => 'The feedback token.
', 'UpdateDeviceStatusRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose device status you want to update.
', 'UpdateUserAttributesRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
', 'VerifySoftwareTokenRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose software token you want to verify.
', 'VerifyUserAttributeRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
', ], ], 'TokenValidityUnitsType' => [ 'base' => 'The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.
', 'refs' => [ 'CreateUserPoolClientRequest$TokenValidityUnits' => 'The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
', 'UpdateUserPoolClientRequest$TokenValidityUnits' => 'The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
', 'UserPoolClientType$TokenValidityUnits' => 'The time units used to specify the token validity times of each token type: ID, access, and refresh.
', ], ], 'TooManyFailedAttemptsException' => [ 'base' => 'This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
', 'refs' => [], ], 'TooManyRequestsException' => [ 'base' => 'This exception is thrown when the user has made too many requests for a given operation.
', 'refs' => [], ], 'UICustomizationType' => [ 'base' => 'A container for the UI customization information for a user pool\'s built-in app UI.
', 'refs' => [ 'GetUICustomizationResponse$UICustomization' => 'The UI customization information.
', 'SetUICustomizationResponse$UICustomization' => 'The UI customization information.
', ], ], 'UnauthorizedException' => [ 'base' => 'Exception that is thrown when the request isn\'t authorized. This can happen due to an invalid access token in the request.
', 'refs' => [], ], 'UnexpectedLambdaException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
', 'refs' => [], ], 'UnsupportedIdentityProviderException' => [ 'base' => 'This exception is thrown when the specified identifier isn\'t supported.
', 'refs' => [], ], 'UnsupportedOperationException' => [ 'base' => 'Exception that is thrown when you attempt to perform an operation that isn\'t enabled for the user pool client.
', 'refs' => [], ], 'UnsupportedTokenTypeException' => [ 'base' => 'Exception that is thrown when an unsupported token is passed to an operation.
', 'refs' => [], ], 'UnsupportedUserStateException' => [ 'base' => 'The request failed because the user is in an unsupported state.
', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAuthEventFeedbackRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAuthEventFeedbackResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceStatusRequest' => [ 'base' => 'Represents the request to update the device status.
', 'refs' => [], ], 'UpdateDeviceStatusResponse' => [ 'base' => 'The response to the request to update the device status.
', 'refs' => [], ], 'UpdateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIdentityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIdentityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourceServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourceServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserAttributesRequest' => [ 'base' => 'Represents the request to update user attributes.
', 'refs' => [], ], 'UpdateUserAttributesResponse' => [ 'base' => 'Represents the response from the server for the request to update user attributes.
', 'refs' => [], ], 'UpdateUserPoolClientRequest' => [ 'base' => 'Represents the request to update the user pool client.
', 'refs' => [], ], 'UpdateUserPoolClientResponse' => [ 'base' => 'Represents the response from the server to the request to update the user pool client.
', 'refs' => [], ], 'UpdateUserPoolDomainRequest' => [ 'base' => 'The UpdateUserPoolDomain request input.
', 'refs' => [], ], 'UpdateUserPoolDomainResponse' => [ 'base' => 'The UpdateUserPoolDomain response output.
', 'refs' => [], ], 'UpdateUserPoolRequest' => [ 'base' => 'Represents the request to update the user pool.
', 'refs' => [], ], 'UpdateUserPoolResponse' => [ 'base' => 'Represents the response from the server when you make a request to update the user pool.
', 'refs' => [], ], 'UserAttributeUpdateSettingsType' => [ 'base' => 'The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users\' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users\' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users\' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users\' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
Contextual data, such as the user\'s device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
', 'refs' => [ 'ConfirmForgotPasswordRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'ConfirmSignUpRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'ForgotPasswordRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'InitiateAuthRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'ResendConfirmationCodeRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'RespondToAuthChallengeRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'SignUpRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', ], ], 'UserFilterType' => [ 'base' => NULL, 'refs' => [ 'ListUsersRequest$Filter' => 'A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\\) character. For example, "family_name = \\"Reddy\\"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "given_name = \\"Jon\\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \\"Jon\\"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers returns all users in the user pool.
You can only search for the following standard attributes:
username (case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status (called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes aren\'t searchable.
You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
', ], ], 'UserImportInProgressException' => [ 'base' => 'This exception is thrown when you\'re trying to modify a user pool while a user import job is in progress for that pool.
', 'refs' => [], ], 'UserImportJobIdType' => [ 'base' => NULL, 'refs' => [ 'DescribeUserImportJobRequest$JobId' => 'The job ID for the user import job.
', 'StartUserImportJobRequest$JobId' => 'The job ID for the user import job.
', 'StopUserImportJobRequest$JobId' => 'The job ID for the user import job.
', 'UserImportJobType$JobId' => 'The job ID for the user import job.
', ], ], 'UserImportJobNameType' => [ 'base' => NULL, 'refs' => [ 'CreateUserImportJobRequest$JobName' => 'The job name for the user import job.
', 'UserImportJobType$JobName' => 'The job name for the user import job.
', ], ], 'UserImportJobStatusType' => [ 'base' => NULL, 'refs' => [ 'UserImportJobType$Status' => 'The status of the user import job. One of the following:
Created - The job was created but not started.
Pending - A transition state. You have started the job, but it has not begun importing users yet.
InProgress - The job has started, and users are being imported.
Stopping - You have stopped the job, but the job has not stopped importing users yet.
Stopped - You have stopped the job, and the job has stopped importing users.
Succeeded - The job has completed successfully.
Failed - The job has stopped due to an error.
Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can\'t be started.
The user import job type.
', 'refs' => [ 'CreateUserImportJobResponse$UserImportJob' => 'The job object that represents the user import job.
', 'DescribeUserImportJobResponse$UserImportJob' => 'The job object that represents the user import job.
', 'StartUserImportJobResponse$UserImportJob' => 'The job object that represents the user import job.
', 'StopUserImportJobResponse$UserImportJob' => 'The job object that represents the user import job.
', 'UserImportJobsListType$member' => NULL, ], ], 'UserImportJobsListType' => [ 'base' => NULL, 'refs' => [ 'ListUserImportJobsResponse$UserImportJobs' => 'The user import jobs.
', ], ], 'UserLambdaValidationException' => [ 'base' => 'This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
', 'refs' => [], ], 'UserMFASettingListType' => [ 'base' => NULL, 'refs' => [ 'AdminGetUserResponse$UserMFASettingList' => 'The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
This exception is thrown when a user isn\'t confirmed successfully.
', 'refs' => [], ], 'UserNotFoundException' => [ 'base' => 'This exception is thrown when a user isn\'t found.
', 'refs' => [], ], 'UserPoolAddOnNotEnabledException' => [ 'base' => 'This exception is thrown when user pool add-ons aren\'t enabled.
', 'refs' => [], ], 'UserPoolAddOnsType' => [ 'base' => 'The user pool add-ons type.
', 'refs' => [ 'CreateUserPoolRequest$UserPoolAddOns' => 'Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
The user pool add-ons.
', ], ], 'UserPoolClientDescription' => [ 'base' => 'The description of the user pool client.
', 'refs' => [ 'UserPoolClientListType$member' => NULL, ], ], 'UserPoolClientListType' => [ 'base' => NULL, 'refs' => [ 'ListUserPoolClientsResponse$UserPoolClients' => 'The user pool clients in the response that lists user pool clients.
', ], ], 'UserPoolClientType' => [ 'base' => 'Contains information about a user pool client.
', 'refs' => [ 'CreateUserPoolClientResponse$UserPoolClient' => 'The user pool client that was just created.
', 'DescribeUserPoolClientResponse$UserPoolClient' => 'The user pool client from a server response to describe the user pool client.
', 'UpdateUserPoolClientResponse$UserPoolClient' => 'The user pool client value from the response from the server when you request to update the user pool client.
', ], ], 'UserPoolDescriptionType' => [ 'base' => 'A user pool description.
', 'refs' => [ 'UserPoolListType$member' => NULL, ], ], 'UserPoolIdType' => [ 'base' => NULL, 'refs' => [ 'AddCustomAttributesRequest$UserPoolId' => 'The user pool ID for the user pool where you want to add custom attributes.
', 'AdminAddUserToGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AdminConfirmSignUpRequest$UserPoolId' => 'The user pool ID for which you want to confirm user registration.
', 'AdminCreateUserRequest$UserPoolId' => 'The user pool ID for the user pool where the user will be created.
', 'AdminDeleteUserAttributesRequest$UserPoolId' => 'The user pool ID for the user pool where you want to delete user attributes.
', 'AdminDeleteUserRequest$UserPoolId' => 'The user pool ID for the user pool where you want to delete the user.
', 'AdminDisableUserRequest$UserPoolId' => 'The user pool ID for the user pool where you want to disable the user.
', 'AdminEnableUserRequest$UserPoolId' => 'The user pool ID for the user pool where you want to enable the user.
', 'AdminForgetDeviceRequest$UserPoolId' => 'The user pool ID.
', 'AdminGetDeviceRequest$UserPoolId' => 'The user pool ID.
', 'AdminGetUserRequest$UserPoolId' => 'The user pool ID for the user pool where you want to get information about the user.
', 'AdminInitiateAuthRequest$UserPoolId' => 'The ID of the Amazon Cognito user pool.
', 'AdminListDevicesRequest$UserPoolId' => 'The user pool ID.
', 'AdminListGroupsForUserRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AdminListUserAuthEventsRequest$UserPoolId' => 'The user pool ID.
', 'AdminRemoveUserFromGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AdminResetUserPasswordRequest$UserPoolId' => 'The user pool ID for the user pool where you want to reset the user\'s password.
', 'AdminRespondToAuthChallengeRequest$UserPoolId' => 'The ID of the Amazon Cognito user pool.
', 'AdminSetUserMFAPreferenceRequest$UserPoolId' => 'The user pool ID.
', 'AdminSetUserPasswordRequest$UserPoolId' => 'The user pool ID for the user pool where you want to set the user\'s password.
', 'AdminSetUserSettingsRequest$UserPoolId' => 'The ID of the user pool that contains the user whose options you\'re setting.
', 'AdminUpdateAuthEventFeedbackRequest$UserPoolId' => 'The user pool ID.
', 'AdminUpdateDeviceStatusRequest$UserPoolId' => 'The user pool ID.
', 'AdminUpdateUserAttributesRequest$UserPoolId' => 'The user pool ID for the user pool where you want to update user attributes.
', 'AdminUserGlobalSignOutRequest$UserPoolId' => 'The user pool ID.
', 'CreateGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'CreateIdentityProviderRequest$UserPoolId' => 'The user pool ID.
', 'CreateResourceServerRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'CreateUserImportJobRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'CreateUserPoolClientRequest$UserPoolId' => 'The user pool ID for the user pool where you want to create a user pool client.
', 'CreateUserPoolDomainRequest$UserPoolId' => 'The user pool ID.
', 'DeleteGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'DeleteIdentityProviderRequest$UserPoolId' => 'The user pool ID.
', 'DeleteResourceServerRequest$UserPoolId' => 'The user pool ID for the user pool that hosts the resource server.
', 'DeleteUserPoolClientRequest$UserPoolId' => 'The user pool ID for the user pool where you want to delete the client.
', 'DeleteUserPoolDomainRequest$UserPoolId' => 'The user pool ID.
', 'DeleteUserPoolRequest$UserPoolId' => 'The user pool ID for the user pool you want to delete.
', 'DescribeIdentityProviderRequest$UserPoolId' => 'The user pool ID.
', 'DescribeResourceServerRequest$UserPoolId' => 'The user pool ID for the user pool that hosts the resource server.
', 'DescribeRiskConfigurationRequest$UserPoolId' => 'The user pool ID.
', 'DescribeUserImportJobRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'DescribeUserPoolClientRequest$UserPoolId' => 'The user pool ID for the user pool you want to describe.
', 'DescribeUserPoolRequest$UserPoolId' => 'The user pool ID for the user pool you want to describe.
', 'DomainDescriptionType$UserPoolId' => 'The user pool ID.
', 'GetCSVHeaderRequest$UserPoolId' => 'The user pool ID for the user pool that the users are to be imported into.
', 'GetCSVHeaderResponse$UserPoolId' => 'The user pool ID for the user pool that the users are to be imported into.
', 'GetGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'GetIdentityProviderByIdentifierRequest$UserPoolId' => 'The user pool ID.
', 'GetSigningCertificateRequest$UserPoolId' => 'The user pool ID.
', 'GetUICustomizationRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'GetUserPoolMfaConfigRequest$UserPoolId' => 'The user pool ID.
', 'GroupType$UserPoolId' => 'The user pool ID for the user pool.
', 'IdentityProviderType$UserPoolId' => 'The user pool ID.
', 'ListGroupsRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'ListIdentityProvidersRequest$UserPoolId' => 'The user pool ID.
', 'ListResourceServersRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'ListUserImportJobsRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'ListUserPoolClientsRequest$UserPoolId' => 'The user pool ID for the user pool where you want to list user pool clients.
', 'ListUsersInGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'ListUsersRequest$UserPoolId' => 'The user pool ID for the user pool on which the search should be performed.
', 'ResourceServerType$UserPoolId' => 'The user pool ID for the user pool that hosts the resource server.
', 'RiskConfigurationType$UserPoolId' => 'The user pool ID.
', 'SetRiskConfigurationRequest$UserPoolId' => 'The user pool ID.
', 'SetUICustomizationRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'SetUserPoolMfaConfigRequest$UserPoolId' => 'The user pool ID.
', 'StartUserImportJobRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'StopUserImportJobRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'UICustomizationType$UserPoolId' => 'The user pool ID for the user pool.
', 'UpdateAuthEventFeedbackRequest$UserPoolId' => 'The user pool ID.
', 'UpdateGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'UpdateIdentityProviderRequest$UserPoolId' => 'The user pool ID.
', 'UpdateResourceServerRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'UpdateUserPoolClientRequest$UserPoolId' => 'The user pool ID for the user pool where you want to update the user pool client.
', 'UpdateUserPoolDomainRequest$UserPoolId' => 'The ID of the user pool that is associated with the custom domain whose certificate you\'re updating.
', 'UpdateUserPoolRequest$UserPoolId' => 'The user pool ID for the user pool you want to update.
', 'UserImportJobType$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'UserPoolClientDescription$UserPoolId' => 'The user pool ID for the user pool where you want to describe the user pool client.
', 'UserPoolClientType$UserPoolId' => 'The user pool ID for the user pool client.
', 'UserPoolDescriptionType$Id' => 'The ID in a user pool description.
', 'UserPoolType$Id' => 'The ID of the user pool.
', ], ], 'UserPoolListType' => [ 'base' => NULL, 'refs' => [ 'ListUserPoolsResponse$UserPools' => 'The user pools from the response to list users.
', ], ], 'UserPoolMfaType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$MfaConfiguration' => 'Specifies MFA configuration details.
', 'GetUserPoolMfaConfigResponse$MfaConfiguration' => 'The multi-factor authentication (MFA) configuration. Valid values include:
OFF MFA won\'t be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
OFF MFA won\'t be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
The MFA configuration. Valid values include:
OFF MFA won\'t be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
Possible values include:
OFF - MFA tokens aren\'t required and can\'t be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify ON when you\'re initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
Can be one of the following values:
OFF - MFA tokens aren\'t required and can\'t be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required when you\'re initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.
A string used to name the user pool.
', 'UserPoolDescriptionType$Name' => 'The name in a user pool description.
', 'UserPoolType$Name' => 'The name of the user pool.
', ], ], 'UserPoolPolicyType' => [ 'base' => 'The policy associated with a user pool.
', 'refs' => [ 'CreateUserPoolRequest$Policies' => 'The policies associated with the new user pool.
', 'UpdateUserPoolRequest$Policies' => 'A container with the policies you want to update in a user pool.
', 'UserPoolType$Policies' => 'The policies associated with the user pool.
', ], ], 'UserPoolTaggingException' => [ 'base' => 'This exception is thrown when a user pool tag can\'t be set or updated.
', 'refs' => [], ], 'UserPoolTagsListType' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'The keys of the tags to remove from the user pool.
', ], ], 'UserPoolTagsType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$UserPoolTags' => 'The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
', 'ListTagsForResourceResponse$Tags' => 'The tags that are assigned to the user pool.
', 'TagResourceRequest$Tags' => 'The tags to assign to the user pool.
', 'UpdateUserPoolRequest$UserPoolTags' => 'The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
', 'UserPoolType$UserPoolTags' => 'The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
', ], ], 'UserPoolType' => [ 'base' => 'A container for information about the user pool.
', 'refs' => [ 'CreateUserPoolResponse$UserPool' => 'A container for the user pool details.
', 'DescribeUserPoolResponse$UserPool' => 'The container of metadata returned by the server to describe the pool.
', ], ], 'UserStatusType' => [ 'base' => NULL, 'refs' => [ 'AdminGetUserResponse$UserStatus' => 'The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
UNKNOWN - User status isn\'t known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
ARCHIVED - User is no longer active.
UNKNOWN - User status isn\'t known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
A user profile in a Amazon Cognito user pool.
', 'refs' => [ 'AdminCreateUserResponse$User' => 'The newly created user.
', 'UsersListType$member' => NULL, ], ], 'UsernameAttributeType' => [ 'base' => NULL, 'refs' => [ 'UsernameAttributesListType$member' => NULL, ], ], 'UsernameAttributesListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$UsernameAttributes' => 'Specifies whether a user can use an email address or phone number as a username when they sign up.
', 'UserPoolType$UsernameAttributes' => 'Specifies whether a user can use an email address or phone number as a username when they sign up.
', ], ], 'UsernameConfigurationType' => [ 'base' => 'The username configuration type.
', 'refs' => [ 'CreateUserPoolRequest$UsernameConfiguration' => 'Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
', 'refs' => [], ], 'UsernameType' => [ 'base' => NULL, 'refs' => [ 'AdminAddUserToGroupRequest$Username' => 'The username for the user.
', 'AdminConfirmSignUpRequest$Username' => 'The user name for which you want to confirm user registration.
', 'AdminCreateUserRequest$Username' => 'The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can\'t be changed.
', 'AdminDeleteUserAttributesRequest$Username' => 'The user name of the user from which you would like to delete attributes.
', 'AdminDeleteUserRequest$Username' => 'The user name of the user you want to delete.
', 'AdminDisableUserRequest$Username' => 'The user name of the user you want to disable.
', 'AdminEnableUserRequest$Username' => 'The user name of the user you want to enable.
', 'AdminForgetDeviceRequest$Username' => 'The user name.
', 'AdminGetDeviceRequest$Username' => 'The user name.
', 'AdminGetUserRequest$Username' => 'The user name of the user you want to retrieve.
', 'AdminGetUserResponse$Username' => 'The user name of the user about whom you\'re receiving information.
', 'AdminListDevicesRequest$Username' => 'The user name.
', 'AdminListGroupsForUserRequest$Username' => 'The username for the user.
', 'AdminListUserAuthEventsRequest$Username' => 'The user pool username or an alias.
', 'AdminRemoveUserFromGroupRequest$Username' => 'The username for the user.
', 'AdminResetUserPasswordRequest$Username' => 'The user name of the user whose password you want to reset.
', 'AdminSetUserMFAPreferenceRequest$Username' => 'The user pool username or alias.
', 'AdminSetUserPasswordRequest$Username' => 'The user name of the user whose password you want to set.
', 'AdminSetUserSettingsRequest$Username' => 'The user name of the user whose options you\'re setting.
', 'AdminUpdateAuthEventFeedbackRequest$Username' => 'The user pool username.
', 'AdminUpdateDeviceStatusRequest$Username' => 'The user name.
', 'AdminUpdateUserAttributesRequest$Username' => 'The user name of the user for whom you want to update user attributes.
', 'AdminUserGlobalSignOutRequest$Username' => 'The user name.
', 'ConfirmForgotPasswordRequest$Username' => 'The user name of the user for whom you want to enter a code to retrieve a forgotten password.
', 'ConfirmSignUpRequest$Username' => 'The user name of the user whose registration you want to confirm.
', 'ForgotPasswordRequest$Username' => 'The user name of the user for whom you want to enter a code to reset a forgotten password.
', 'GetUserResponse$Username' => 'The user name of the user you want to retrieve from the get user request.
', 'ResendConfirmationCodeRequest$Username' => 'The username attribute of the user to whom you want to resend a confirmation code.
The user name of the user you want to register.
', 'UpdateAuthEventFeedbackRequest$Username' => 'The user pool username.
', 'UserType$Username' => 'The user name of the user you want to describe.
', ], ], 'UsersListType' => [ 'base' => NULL, 'refs' => [ 'ListUsersInGroupResponse$Users' => 'The users returned in the request to list users.
', 'ListUsersResponse$Users' => 'The users returned in the request to list users.
', ], ], 'VerificationMessageTemplateType' => [ 'base' => 'The template for verification messages.
', 'refs' => [ 'CreateUserPoolRequest$VerificationMessageTemplate' => 'The template for the verification message that the user sees when the app requests permission to access the user\'s information.
', 'UpdateUserPoolRequest$VerificationMessageTemplate' => 'The template for verification messages.
', 'UserPoolType$VerificationMessageTemplate' => 'The template for verification messages.
', ], ], 'VerifiedAttributeType' => [ 'base' => NULL, 'refs' => [ 'AttributesRequireVerificationBeforeUpdateType$member' => NULL, 'VerifiedAttributesListType$member' => NULL, ], ], 'VerifiedAttributesListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$AutoVerifiedAttributes' => 'The attributes to be auto-verified. Possible values: email, phone_number.
', 'UpdateUserPoolRequest$AutoVerifiedAttributes' => 'The attributes that are automatically verified when Amazon Cognito requests to update user pools.
', 'UserPoolType$AutoVerifiedAttributes' => 'The attributes that are auto-verified in a user pool.
', ], ], 'VerifySoftwareTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'VerifySoftwareTokenResponse' => [ 'base' => NULL, 'refs' => [], ], 'VerifySoftwareTokenResponseType' => [ 'base' => NULL, 'refs' => [ 'VerifySoftwareTokenResponse$Status' => 'The status of the verify software token.
', ], ], 'VerifyUserAttributeRequest' => [ 'base' => 'Represents the request to verify user attributes.
', 'refs' => [], ], 'VerifyUserAttributeResponse' => [ 'base' => 'A container representing the response from the server from the request to verify user attributes.
', 'refs' => [], ], 'WrappedBooleanType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$EnableTokenRevocation' => 'Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don\'t include this parameter, token revocation is automatically activated for the new user pool client.
', 'CreateUserPoolClientRequest$EnablePropagateAdditionalUserContextData' => 'Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can\'t send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Indicates whether compromised credentials were detected during an authentication event.
', 'UpdateUserPoolClientRequest$EnableTokenRevocation' => 'Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
', 'UpdateUserPoolClientRequest$EnablePropagateAdditionalUserContextData' => 'Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can\'t send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
', 'UserPoolClientType$EnablePropagateAdditionalUserContextData' => 'When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
When EnablePropagateAdditionalUserContextData is false, you can\'t send your user\'s source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn\'t affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.
Valid values include:
Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using either "username" or "Username". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.
With the Amazon Cognito user pools API, you can set up user pools and app clients, and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can link IdP users to native user profiles. Learn more about the authentication and authorization of federated users in the Using the Amazon Cognito user pools API and user pool endpoints.
This API reference provides detailed information about API operations and object types in Amazon Cognito. At the bottom of the page for each API operation and object, under See Also, you can learn how to use it in an Amazon Web Services SDK in the language of your choice.
Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side user operations. For more information, see Using the Amazon Cognito native and OIDC APIs in the Amazon Cognito Developer Guide.
You can also start reading about the CognitoIdentityProvider client in the following SDK guides.
To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.
', 'operations' => [ 'AddCustomAttributes' => 'Adds additional user attributes to the user pool schema.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Adds the specified user to the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Confirms user registration as an admin without using a confirmation code. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates a new user in the specified user pool.
If MessageAction isn\'t set, the default is to send a welcome message via email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won\'t send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Deletes a user as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Deletes the user attributes in a user pool as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can\'t use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser.
The ProviderName must match the value specified when creating an IdP for the pool.
To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user.
The ProviderAttributeName must always be Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Deactivates a user and revokes all access tokens for the user. A deactivated user can\'t sign in, but still appears in the responses to GetUser and ListUsers API requests.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Enables the specified user as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Forgets the device, as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Gets the device, as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Initiates the authentication flow, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account.
The maximum number of federated identities linked to a user is five.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists devices, as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the groups that the user belongs to.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Removes the specified user from the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Resets the specified user\'s password in a user pool as an administrator. Works on any user.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Deactivates a user\'s password, requiring them to change it. If a user tries to sign in after the API is called, Amazon Cognito responds with a PasswordResetRequiredException error. Your app must then perform the actions that reset your user\'s password: the forgot-password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Responds to an authentication challenge, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
The user\'s multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Sets the specified user\'s password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn\'t sign in before it expires, the user won\'t be able to sign in, and an administrator must reset their password.
Once the user has set a new password, or the password is permanent, the user status is set to Confirmed.
AdminSetUserPassword can set a password for the user profile that Amazon Cognito creates for third-party federated users. When you set a password, the federated user\'s status changes from EXTERNAL_PROVIDER to CONFIRMED. A user in this state can sign in as a federated user, and initiate authentication flows in the API like a linked native user. They can also modify their password and attributes in token-authenticated API requests like ChangePassword and UpdateUserAttributes. As a best security practice and to keep users in sync with your external IdP, don\'t set passwords on federated user profiles. To set up a federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user profile.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This action is no longer supported. You can use it to configure only SMS MFA. You can\'t use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates the device status as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user\'s attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Signs out a user from all devices. AdminUserGlobalSignOut invalidates all identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.
Your app isn\'t aware that a user\'s access token is revoked unless it attempts to authorize a user pools API request with an access token that contains the scope aws.cognito.signin.user.admin. Your app might otherwise accept access tokens until they expire.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user\'s access token, or a session string from a challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don\'t verify the software token and your user pool doesn\'t require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user\'s TOTP.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Changes the password for a specified user in a user pool.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Confirms tracking of the device. This API call is the call that begins device tracking.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Allows a user to enter a confirmation code to reset a forgotten password.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Confirms registration of a new user.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Creates a new group in the specified user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates an IdP for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates a new OAuth2.0 resource server and defines custom scopes within it.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates a user import job.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
If you don\'t provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
If you don\'t provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Creates a new domain for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Deletes a group.
Calling this action requires developer credentials.
', 'DeleteIdentityProvider' => 'Deletes an IdP for a user pool.
', 'DeleteResourceServer' => 'Deletes a resource server.
', 'DeleteUser' => 'Allows a user to delete their own user profile.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Deletes the attributes for a user.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Deletes the specified Amazon Cognito user pool.
', 'DeleteUserPoolClient' => 'Allows the developer to delete the user pool client.
', 'DeleteUserPoolDomain' => 'Deletes a domain for a user pool.
', 'DescribeIdentityProvider' => 'Gets information about a specific IdP.
', 'DescribeResourceServer' => 'Describes a resource server.
', 'DescribeRiskConfiguration' => 'Describes the risk configuration.
', 'DescribeUserImportJob' => 'Describes the user import job.
', 'DescribeUserPool' => 'Returns the configuration information and metadata of the specified user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Client method for returning the configuration information and metadata of the specified user pool app client.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Gets information about a domain.
', 'ForgetDevice' => 'Forgets the specified device.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user\'s password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
If neither a verified phone number nor a verified email exists, this API returns InvalidParameterException. If your app client has a client secret and you don\'t provide a SECRET_HASH parameter, this API returns NotAuthorizedException.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
', 'GetDevice' => 'Gets the device.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Gets a group.
Calling this action requires developer credentials.
', 'GetIdentityProviderByIdentifier' => 'Gets the specified IdP.
', 'GetLogDeliveryConfiguration' => 'Gets the detailed activity logging configuration for a user pool.
', 'GetSigningCertificate' => 'This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.
Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to GetSigningCertificate, but doesn\'t invalidate the original certificate.
Gets the user interface (UI) Customization information for a particular app client\'s app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app clientId is ALL), then that information is returned. If nothing is present, then an empty shape is returned.
Gets the user attributes and metadata for a user.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Gets the user pool multi-factor authentication (MFA) configuration.
', 'GlobalSignOut' => 'Signs out a user from all devices. GlobalSignOut invalidates all identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.
Your app isn\'t aware that a user\'s access token is revoked unless it attempts to authorize a user pools API request with an access token that contains the scope aws.cognito.signin.user.admin. Your app might otherwise accept access tokens until they expire.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Initiates sign-in for a user in the Amazon Cognito user directory. You can\'t sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Lists the sign-in devices that Amazon Cognito has registered to the current user.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Lists the groups associated with a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists information about all IdPs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the resource servers for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
', 'ListUserImportJobs' => 'Lists user import jobs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the clients that have been created for the specified user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the user pools associated with an Amazon Web Services account.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists users and their basic details in a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Lists the users in the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Responds to the authentication challenge.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can\'t use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Sets up or modifies the detailed activity logging configuration of a user pool.
', 'SetRiskConfiguration' => 'Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.
To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
Sets the user interface (UI) customization information for a user pool\'s built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app\'s pages, and the service will throw an error.
Set the user\'s multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Sets the user pool multi-factor authentication (MFA) configuration.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This action is no longer supported. You can use it to configure only SMS MFA. You can\'t use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Registers the user in the specified user pool and creates a user name, password, and user attributes.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Starts the user import.
', 'StopUserImportJob' => 'Stops the user import job.
', 'TagResource' => 'Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool, and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
', 'UntagResource' => 'Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.
', 'UpdateAuthEventFeedback' => 'Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Updates the device status.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Updates the specified group with the specified attributes.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates IdP information for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates the name and scopes of resource server. All other fields are read-only.
If you don\'t provide a value for an attribute, it is set to the default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Allows a user to update a specific attribute (one at a time).
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool.
If you don\'t provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don\'t provide a value for an attribute, Amazon Cognito sets it to its default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can\'t use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Use this API to register a user\'s entered time-based one-time password (TOTP) code and mark the user\'s software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
Verifies the specified user attributes in the user pool.
If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
Amazon Cognito doesn\'t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can\'t use IAM credentials to authorize requests, and you can\'t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
The Amazon Web Services ID for the user pool owner.
', ], ], 'AccessTokenValidityType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$AccessTokenValidity' => 'The access token time limit. After this limit expires, your user can\'t use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
', 'UpdateUserPoolClientRequest$AccessTokenValidity' => 'The access token time limit. After this limit expires, your user can\'t use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
', 'UserPoolClientType$AccessTokenValidity' => 'The access token time limit. After this limit expires, your user can\'t use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
', ], ], 'AccountRecoverySettingType' => [ 'base' => 'The data type for AccountRecoverySetting.
The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn\'t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn\'t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn\'t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
Flag specifying whether to send a notification.
', ], ], 'AccountTakeoverActionType' => [ 'base' => 'Account takeover action type.
', 'refs' => [ 'AccountTakeoverActionsType$LowAction' => 'Action to take for a low risk.
', 'AccountTakeoverActionsType$MediumAction' => 'Action to take for a medium risk.
', 'AccountTakeoverActionsType$HighAction' => 'Action to take for a high risk.
', ], ], 'AccountTakeoverActionsType' => [ 'base' => 'Account takeover actions type.
', 'refs' => [ 'AccountTakeoverRiskConfigurationType$Actions' => 'Account takeover risk configuration actions.
', ], ], 'AccountTakeoverEventActionType' => [ 'base' => NULL, 'refs' => [ 'AccountTakeoverActionType$EventAction' => 'The action to take in response to the account takeover action. Valid values are as follows:
BLOCK Choosing this action will block the request.
MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.
MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.
NO_ACTION Allow the user to sign in.
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
', 'refs' => [ 'RiskConfigurationType$AccountTakeoverRiskConfiguration' => 'The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.
The account takeover risk configuration.
', ], ], 'AddCustomAttributesRequest' => [ 'base' => 'Represents the request to add custom attributes.
', 'refs' => [], ], 'AddCustomAttributesResponse' => [ 'base' => 'Represents the response from the server for the request to add custom attributes.
', 'refs' => [], ], 'AdminAddUserToGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminConfirmSignUpRequest' => [ 'base' => 'Confirm a user\'s registration as a user pool administrator.
', 'refs' => [], ], 'AdminConfirmSignUpResponse' => [ 'base' => 'Represents the response from the server for the request to confirm registration.
', 'refs' => [], ], 'AdminCreateUserConfigType' => [ 'base' => 'The configuration for creating a new user profile.
', 'refs' => [ 'CreateUserPoolRequest$AdminCreateUserConfig' => 'The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
Represents the request to create a user in the specified user pool.
', 'refs' => [], ], 'AdminCreateUserResponse' => [ 'base' => 'Represents the response from the server to the request to create the user.
', 'refs' => [], ], 'AdminCreateUserUnusedAccountValidityDaysType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserConfigType$UnusedAccountValidityDays' => 'The user account expiration limit, in days, after which a new account that hasn\'t signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.
If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.
Represents the request to delete user attributes as an administrator.
', 'refs' => [], ], 'AdminDeleteUserAttributesResponse' => [ 'base' => 'Represents the response received from the server for a request to delete user attributes.
', 'refs' => [], ], 'AdminDeleteUserRequest' => [ 'base' => 'Represents the request to delete a user as an administrator.
', 'refs' => [], ], 'AdminDisableProviderForUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminDisableProviderForUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminDisableUserRequest' => [ 'base' => 'Represents the request to disable the user as an administrator.
', 'refs' => [], ], 'AdminDisableUserResponse' => [ 'base' => 'Represents the response received from the server to disable the user as an administrator.
', 'refs' => [], ], 'AdminEnableUserRequest' => [ 'base' => 'Represents the request that enables the user as an administrator.
', 'refs' => [], ], 'AdminEnableUserResponse' => [ 'base' => 'Represents the response from the server for the request to enable a user as an administrator.
', 'refs' => [], ], 'AdminForgetDeviceRequest' => [ 'base' => 'Sends the forgot device request, as an administrator.
', 'refs' => [], ], 'AdminGetDeviceRequest' => [ 'base' => 'Represents the request to get the device, as an administrator.
', 'refs' => [], ], 'AdminGetDeviceResponse' => [ 'base' => 'Gets the device response, as an administrator.
', 'refs' => [], ], 'AdminGetUserRequest' => [ 'base' => 'Represents the request to get the specified user as an administrator.
', 'refs' => [], ], 'AdminGetUserResponse' => [ 'base' => 'Represents the response from the server from the request to get the specified user as an administrator.
', 'refs' => [], ], 'AdminInitiateAuthRequest' => [ 'base' => 'Initiates the authorization request, as an administrator.
', 'refs' => [], ], 'AdminInitiateAuthResponse' => [ 'base' => 'Initiates the authentication response, as an administrator.
', 'refs' => [], ], 'AdminLinkProviderForUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminLinkProviderForUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminListDevicesRequest' => [ 'base' => 'Represents the request to list devices, as an administrator.
', 'refs' => [], ], 'AdminListDevicesResponse' => [ 'base' => 'Lists the device\'s response, as an administrator.
', 'refs' => [], ], 'AdminListGroupsForUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminListGroupsForUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminListUserAuthEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminListUserAuthEventsResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminRemoveUserFromGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminResetUserPasswordRequest' => [ 'base' => 'Represents the request to reset a user\'s password as an administrator.
', 'refs' => [], ], 'AdminResetUserPasswordResponse' => [ 'base' => 'Represents the response from the server to reset a user password as an administrator.
', 'refs' => [], ], 'AdminRespondToAuthChallengeRequest' => [ 'base' => 'The request to respond to the authentication challenge, as an administrator.
', 'refs' => [], ], 'AdminRespondToAuthChallengeResponse' => [ 'base' => 'Responds to the authentication challenge, as an administrator.
', 'refs' => [], ], 'AdminSetUserMFAPreferenceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminSetUserMFAPreferenceResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminSetUserPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminSetUserPasswordResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminSetUserSettingsRequest' => [ 'base' => 'You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
', 'refs' => [], ], 'AdminSetUserSettingsResponse' => [ 'base' => 'Represents the response from the server to set user settings as an administrator.
', 'refs' => [], ], 'AdminUpdateAuthEventFeedbackRequest' => [ 'base' => NULL, 'refs' => [], ], 'AdminUpdateAuthEventFeedbackResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdminUpdateDeviceStatusRequest' => [ 'base' => 'The request to update the device status, as an administrator.
', 'refs' => [], ], 'AdminUpdateDeviceStatusResponse' => [ 'base' => 'The status response to the request to update the device, as an administrator.
', 'refs' => [], ], 'AdminUpdateUserAttributesRequest' => [ 'base' => 'Represents the request to update the user\'s attributes as an administrator.
', 'refs' => [], ], 'AdminUpdateUserAttributesResponse' => [ 'base' => 'Represents the response from the server for the request to update user attributes as an administrator.
', 'refs' => [], ], 'AdminUserGlobalSignOutRequest' => [ 'base' => 'The request to sign out of all devices, as an administrator.
', 'refs' => [], ], 'AdminUserGlobalSignOutResponse' => [ 'base' => 'The global sign-out response, as an administrator.
', 'refs' => [], ], 'AdvancedSecurityModeType' => [ 'base' => NULL, 'refs' => [ 'UserPoolAddOnsType$AdvancedSecurityMode' => 'The operating mode of advanced security features in your user pool.
', ], ], 'AliasAttributeType' => [ 'base' => NULL, 'refs' => [ 'AliasAttributesListType$member' => NULL, ], ], 'AliasAttributesListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$AliasAttributes' => 'Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
', 'UserPoolType$AliasAttributes' => 'The attributes that are aliased in a user pool.
', ], ], 'AliasExistsException' => [ 'base' => 'This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you\'ve configured to use email address or phone number as a sign-in alias.
', 'refs' => [], ], 'AnalyticsConfigurationType' => [ 'base' => 'The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
In Regions where Amazon Pinpoint isn\'t available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn\'t available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn\'t available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The Amazon Pinpoint analytics configuration for the user pool client.
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
An Amazon Pinpoint analytics endpoint.
An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.
', 'refs' => [ 'AdminInitiateAuthRequest$AnalyticsMetadata' => 'The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.
The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
', 'AnalyticsConfigurationType$RoleArn' => 'The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
', 'CloudWatchLogsConfigurationType$LogGroupArn' => 'The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs. The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account as your user pool.
', 'CreateGroupRequest$RoleArn' => 'The role Amazon Resource Name (ARN) for the group.
', 'CreateUserImportJobRequest$CloudWatchLogsRoleArn' => 'The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
', 'CustomDomainConfigType$CertificateArn' => 'The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
', 'CustomEmailLambdaVersionConfigType$LambdaArn' => 'The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.
', 'CustomSMSLambdaVersionConfigType$LambdaArn' => 'The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.
', 'EmailConfigurationType$SourceArn' => 'The ARN of a verified email address or an address from a verified domain in Amazon SES. You can set a SourceArn email from a verified domain only with an API request. You can set a verified email address, but not an address in a verified domain, in the Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.
The role Amazon Resource Name (ARN) for the group.
', 'LambdaConfigType$PreSignUp' => 'A pre-registration Lambda trigger.
', 'LambdaConfigType$CustomMessage' => 'A custom Message Lambda trigger.
', 'LambdaConfigType$PostConfirmation' => 'A post-confirmation Lambda trigger.
', 'LambdaConfigType$PreAuthentication' => 'A pre-authentication Lambda trigger.
', 'LambdaConfigType$PostAuthentication' => 'A post-authentication Lambda trigger.
', 'LambdaConfigType$DefineAuthChallenge' => 'Defines the authentication challenge.
', 'LambdaConfigType$CreateAuthChallenge' => 'Creates an authentication challenge.
', 'LambdaConfigType$VerifyAuthChallengeResponse' => 'Verifies the authentication challenge response.
', 'LambdaConfigType$PreTokenGeneration' => 'A Lambda trigger that is invoked before token generation.
', 'LambdaConfigType$UserMigration' => 'The user migration Lambda config type.
', 'LambdaConfigType$KMSKeyID' => 'The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.
The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
', 'NotifyConfigurationType$SourceArn' => 'The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the From parameter.
The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
', 'TagResourceRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the user pool to assign the tags to.
', 'UntagResourceRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
', 'UpdateGroupRequest$RoleArn' => 'The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.
The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
', 'UserPoolType$Arn' => 'The Amazon Resource Name (ARN) for the user pool.
', ], ], 'AssociateSoftwareTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateSoftwareTokenResponse' => [ 'base' => NULL, 'refs' => [], ], 'AttributeDataType' => [ 'base' => NULL, 'refs' => [ 'SchemaAttributeType$AttributeDataType' => 'The data format of the values for your attribute.
', ], ], 'AttributeListType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserRequest$UserAttributes' => 'An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).
For custom attributes, you must prepend the custom: prefix to the attribute name.
To send a message inviting the user to sign up, you must specify the user\'s email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling AdminUpdateUserAttributes.
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
The user\'s validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user\'s domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user\'s validation data isn\'t persisted.
', 'AdminGetUserResponse$UserAttributes' => 'An array of name-value pairs representing user attributes.
', 'AdminUpdateUserAttributesRequest$UserAttributes' => 'An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
To update the value of an attribute that requires verification in the same API request, include the email_verified or phone_number_verified attribute, with a value of true. If you set the email_verified or phone_number_verified value for an email or phone_number attribute that requires verification to true, Amazon Cognito doesn’t send a verification message to your user.
The device attributes.
', 'GetUserResponse$UserAttributes' => 'An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
The validation data in the request to register a user.
', 'UpdateUserAttributesRequest$UserAttributes' => 'An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
', 'UserType$Attributes' => 'A container with information about the user type attributes.
', ], ], 'AttributeMappingKeyType' => [ 'base' => NULL, 'refs' => [ 'AttributeMappingType$key' => NULL, ], ], 'AttributeMappingType' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$AttributeMapping' => 'A mapping of IdP attributes to standard and custom user pool attributes.
', 'IdentityProviderType$AttributeMapping' => 'A mapping of IdP attributes to standard and custom user pool attributes.
', 'UpdateIdentityProviderRequest$AttributeMapping' => 'The IdP attribute mapping to be changed.
', ], ], 'AttributeNameListType' => [ 'base' => NULL, 'refs' => [ 'AdminDeleteUserAttributesRequest$UserAttributeNames' => 'An array of strings representing the user attribute names you want to delete.
For custom attributes, you must prepend the custom: prefix to the attribute name.
An array of strings representing the user attribute names you want to delete.
For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
The name of the attribute.
', 'CodeDeliveryDetailsType$AttributeName' => 'The name of the attribute that Amazon Cognito verifies with the code.
', 'GetUserAttributeVerificationCodeRequest$AttributeName' => 'The attribute name returned by the server response to get the user attribute verification code.
', 'MFAOptionType$AttributeName' => 'The attribute name of the MFA option type. The only valid value is phone_number.
The attribute name in the request to verify user attributes.
', ], ], 'AttributeType' => [ 'base' => 'Specifies whether the attribute is standard or custom.
', 'refs' => [ 'AttributeListType$member' => NULL, ], ], 'AttributeValueType' => [ 'base' => NULL, 'refs' => [ 'AttributeType$Value' => 'The value of the attribute.
', ], ], 'AttributesRequireVerificationBeforeUpdateType' => [ 'base' => NULL, 'refs' => [ 'UserAttributeUpdateSettingsType$AttributesRequireVerificationBeforeUpdate' => 'Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.
You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.
When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn\'t require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.
The authentication event type.
', 'refs' => [ 'AuthEventsType$member' => NULL, ], ], 'AuthEventsType' => [ 'base' => NULL, 'refs' => [ 'AdminListUserAuthEventsResponse$AuthEvents' => 'The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse.
The authentication flow for this call to run. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution.
ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.
The authentication flow for this call to run. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns the next challenge or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn\'t find the user name in the user pool.
ADMIN_NO_SRP_AUTH isn\'t a valid value.
The authentication parameters. These are inputs corresponding to the AuthFlow that you\'re invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For ADMIN_USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
The authentication parameters. These are inputs corresponding to the AuthFlow that you\'re invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
The authentication result.
', 'refs' => [ 'AdminInitiateAuthResponse$AuthenticationResult' => 'The result of the authentication response. This is only returned if the caller doesn\'t need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
The result returned by the server in response to the authentication request.
', 'InitiateAuthResponse$AuthenticationResult' => 'The result of the authentication response. This result is only returned if the caller doesn\'t need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
The result returned by the server in response to the request to respond to the authentication challenge.
', ], ], 'BlockedIPRangeListType' => [ 'base' => NULL, 'refs' => [ 'RiskExceptionConfigurationType$BlockedIPRangeList' => 'Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.
', ], ], 'BooleanType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserConfigType$AllowAdminCreateUserOnly' => 'Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
Indicates that the status is enabled.
True if the password is permanent, False if it is temporary.
If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
Indicates whether the user confirmation must confirm the device response.
', 'CreateUserPoolClientRequest$AllowedOAuthFlowsUserPoolClient' => 'Set to true to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don\'t set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false.
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
When true, Amazon Cognito doesn\'t automatically remember a user\'s device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user\'s choice in an UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.
In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
', 'PasswordPolicyType$RequireLowercase' => 'In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
', 'PasswordPolicyType$RequireNumbers' => 'In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
', 'PasswordPolicyType$RequireSymbols' => 'In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
', 'SMSMfaSettingsType$Enabled' => 'Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.
', 'SMSMfaSettingsType$PreferredMfa' => 'Specifies whether SMS is the preferred MFA method.
', 'SchemaAttributeType$DeveloperOnlyAttribute' => 'You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.
Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won\'t be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can\'t be updated using UpdateUserAttributes.
Specifies whether the value of the attribute can be changed.
Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
Specifies whether a user pool attribute is required. If the attribute is required and the user doesn\'t provide a value, registration or sign-in will fail.
', 'SignUpResponse$UserConfirmed' => 'A response from the server indicating that a user registration has been confirmed.
', 'SoftwareTokenMfaConfigType$Enabled' => 'Specifies whether software token MFA is activated.
', 'SoftwareTokenMfaSettingsType$Enabled' => 'Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.
', 'SoftwareTokenMfaSettingsType$PreferredMfa' => 'Specifies whether software token MFA is the preferred MFA method.
', 'UpdateUserPoolClientRequest$AllowedOAuthFlowsUserPoolClient' => 'Set to true to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don\'t set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false.
Set to true to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don\'t set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false.
Specifies whether the user is enabled.
', ], ], 'CSSType' => [ 'base' => NULL, 'refs' => [ 'SetUICustomizationRequest$CSS' => 'The CSS values in the UI customization.
', 'UICustomizationType$CSS' => 'The CSS values in the UI customization.
', ], ], 'CSSVersionType' => [ 'base' => NULL, 'refs' => [ 'UICustomizationType$CSSVersion' => 'The CSS version number.
', ], ], 'CallbackURLsListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$CallbackURLs' => 'A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
', 'UpdateUserPoolClientRequest$CallbackURLs' => 'A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
', ], ], 'ChallengeName' => [ 'base' => NULL, 'refs' => [ 'ChallengeResponseType$ChallengeName' => 'The challenge name.
', ], ], 'ChallengeNameType' => [ 'base' => NULL, 'refs' => [ 'AdminInitiateAuthResponse$ChallengeName' => 'The name of the challenge that you\'re responding to with this call. This is returned in the AdminInitiateAuth response if you must pass another challenge.
MFA_SETUP: If MFA is required, users who don\'t have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate.
SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) software token MFA.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren\'t required by your user pool and that your app client can write. For more information, see AdminRespondToAuthChallenge.
In a NEW_PASSWORD_REQUIRED challenge response, you can\'t modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, users will need help from an administrator to add a phone number to their account and then call InitiateAuth again to restart sign-in.
The challenge name. For more information, see AdminInitiateAuth.
', 'AdminRespondToAuthChallengeResponse$ChallengeName' => 'The name of the challenge. For more information, see AdminInitiateAuth.
', 'InitiateAuthResponse$ChallengeName' => 'The name of the challenge that you\'re responding to with this call. This name is returned in the AdminInitiateAuth response if you must pass another challenge.
Valid values include the following:
All of the following challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login.
Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren\'t required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge.
In a NEW_PASSWORD_REQUIRED challenge response, you can\'t modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call InitiateAuth again to restart sign-in.
The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH isn\'t a valid value.
The challenge name. For more information, see InitiateAuth.
', ], ], 'ChallengeParametersType' => [ 'base' => NULL, 'refs' => [ 'AdminInitiateAuthResponse$ChallengeParameters' => 'The challenge parameters. These are returned to you in the AdminInitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
The value of the USER_ID_FOR_SRP attribute is the user\'s actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute can\'t be an alias.
The challenge parameters. For more information, see AdminInitiateAuth.
', 'InitiateAuthResponse$ChallengeParameters' => 'The challenge parameters. These are returned in the InitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
The challenge parameters. For more information, see InitiateAuth.
', ], ], 'ChallengeResponse' => [ 'base' => NULL, 'refs' => [ 'ChallengeResponseType$ChallengeResponse' => 'The challenge response.
', ], ], 'ChallengeResponseListType' => [ 'base' => NULL, 'refs' => [ 'AuthEventType$ChallengeResponses' => 'The challenge responses.
', ], ], 'ChallengeResponseType' => [ 'base' => 'The challenge response type.
', 'refs' => [ 'ChallengeResponseListType$member' => NULL, ], ], 'ChallengeResponsesType' => [ 'base' => NULL, 'refs' => [ 'AdminRespondToAuthChallengeRequest$ChallengeResponses' => 'The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren\'t required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can\'t modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
The value of the USERNAME attribute must be the user\'s actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).
SMS_MFA: SMS_MFA_CODE, USERNAME.
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.
PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren\'t required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can\'t modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
Represents the request to change a user password.
', 'refs' => [], ], 'ChangePasswordResponse' => [ 'base' => 'The response from the server to the change password request.
', 'refs' => [], ], 'ClientIdType' => [ 'base' => NULL, 'refs' => [ 'AdminInitiateAuthRequest$ClientId' => 'The app client ID.
', 'AdminRespondToAuthChallengeRequest$ClientId' => 'The app client ID.
', 'ConfirmForgotPasswordRequest$ClientId' => 'The app client ID of the app associated with the user pool.
', 'ConfirmSignUpRequest$ClientId' => 'The ID of the app client associated with the user pool.
', 'DeleteUserPoolClientRequest$ClientId' => 'The app client ID of the app associated with the user pool.
', 'DescribeRiskConfigurationRequest$ClientId' => 'The app client ID.
', 'DescribeUserPoolClientRequest$ClientId' => 'The app client ID of the app associated with the user pool.
', 'ForgotPasswordRequest$ClientId' => 'The ID of the client associated with the user pool.
', 'GetUICustomizationRequest$ClientId' => 'The client ID for the client app.
', 'InitiateAuthRequest$ClientId' => 'The app client ID.
', 'ResendConfirmationCodeRequest$ClientId' => 'The ID of the client associated with the user pool.
', 'RespondToAuthChallengeRequest$ClientId' => 'The app client ID.
', 'RevokeTokenRequest$ClientId' => 'The client ID for the token that you want to revoke.
', 'RiskConfigurationType$ClientId' => 'The app client ID.
', 'SetRiskConfigurationRequest$ClientId' => 'The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.
Otherwise, ClientId is mapped to the client. When the client ID isn\'t null, the user pool configuration is overridden and the risk configuration for the client is used instead.
The client ID for the client app.
', 'SignUpRequest$ClientId' => 'The ID of the client associated with the user pool.
', 'UICustomizationType$ClientId' => 'The client ID for the client app.
', 'UpdateUserPoolClientRequest$ClientId' => 'The ID of the client associated with the user pool.
', 'UserPoolClientDescription$ClientId' => 'The ID of the client associated with the user pool.
', 'UserPoolClientType$ClientId' => 'The ID of the client associated with the user pool.
', ], ], 'ClientMetadataType' => [ 'base' => NULL, 'refs' => [ 'AdminConfirmSignUpRequest$ClientMetadata' => 'A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
Pre signup
Pre authentication
User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn\'t provide the ClientMetadata value as input:
Post authentication
Custom message
Pre token generation
Create auth challenge
Define auth challenge
Verify auth challenge
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
pre sign-up
custom message
post authentication
user migration
pre token generation
define auth challenge
create auth challenge
verify auth challenge response
When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
Pre signup
Pre authentication
User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn\'t provide the ClientMetadata value as input:
Post authentication
Custom message
Pre token generation
Create auth challenge
Define auth challenge
Verify auth challenge
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won\'t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn\'t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don\'t use Amazon Cognito to provide sensitive information.
The client name for the user pool client you would like to create.
', 'UpdateUserPoolClientRequest$ClientName' => 'The client name from the update user pool client request.
', 'UserPoolClientDescription$ClientName' => 'The client name from the user pool client description.
', 'UserPoolClientType$ClientName' => 'The client name from the user pool request of the client type.
', ], ], 'ClientPermissionListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$ReadAttributes' => 'The read attributes.
', 'CreateUserPoolClientRequest$WriteAttributes' => 'The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
', 'UpdateUserPoolClientRequest$ReadAttributes' => 'The read-only attributes of the user pool.
', 'UpdateUserPoolClientRequest$WriteAttributes' => 'The writeable attributes of the user pool.
', 'UserPoolClientType$ReadAttributes' => 'The Read-only attributes.
', 'UserPoolClientType$WriteAttributes' => 'The writeable attributes.
', ], ], 'ClientPermissionType' => [ 'base' => NULL, 'refs' => [ 'ClientPermissionListType$member' => NULL, ], ], 'ClientSecretType' => [ 'base' => NULL, 'refs' => [ 'RevokeTokenRequest$ClientSecret' => 'The secret for the client ID. This is required only if the client ID has a secret.
', 'UserPoolClientType$ClientSecret' => 'The client secret from the user pool request of the client type.
', ], ], 'CloudWatchLogsConfigurationType' => [ 'base' => 'The CloudWatch logging destination of a user pool detailed activity logging configuration.
', 'refs' => [ 'LogConfigurationType$CloudWatchLogsConfiguration' => 'The CloudWatch logging destination of a user pool.
', ], ], 'CodeDeliveryDetailsListType' => [ 'base' => NULL, 'refs' => [ 'UpdateUserAttributesResponse$CodeDeliveryDetailsList' => 'The code delivery details list from the server for the request to update user attributes.
', ], ], 'CodeDeliveryDetailsType' => [ 'base' => 'The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.
', 'refs' => [ 'CodeDeliveryDetailsListType$member' => NULL, 'ForgotPasswordResponse$CodeDeliveryDetails' => 'The code delivery details returned by the server in response to the request to reset a password.
', 'GetUserAttributeVerificationCodeResponse$CodeDeliveryDetails' => 'The code delivery details returned by the server in response to the request to get the user attribute verification code.
', 'ResendConfirmationCodeResponse$CodeDeliveryDetails' => 'The code delivery details returned by the server in response to the request to resend the confirmation code.
', 'SignUpResponse$CodeDeliveryDetails' => 'The code delivery details returned by the server response to the user registration request.
', ], ], 'CodeDeliveryFailureException' => [ 'base' => 'This exception is thrown when a verification code fails to deliver successfully.
', 'refs' => [], ], 'CodeMismatchException' => [ 'base' => 'This exception is thrown if the provided code doesn\'t match what the server was expecting.
', 'refs' => [], ], 'CompletionMessageType' => [ 'base' => NULL, 'refs' => [ 'UserImportJobType$CompletionMessage' => 'The message returned when the user import job is completed.
', ], ], 'CompromisedCredentialsActionsType' => [ 'base' => 'The compromised credentials actions type.
', 'refs' => [ 'CompromisedCredentialsRiskConfigurationType$Actions' => 'The compromised credentials risk configuration actions.
', ], ], 'CompromisedCredentialsEventActionType' => [ 'base' => NULL, 'refs' => [ 'CompromisedCredentialsActionsType$EventAction' => 'The event action.
', ], ], 'CompromisedCredentialsRiskConfigurationType' => [ 'base' => 'The compromised credentials risk configuration type.
', 'refs' => [ 'RiskConfigurationType$CompromisedCredentialsRiskConfiguration' => 'The compromised credentials risk configuration object, including the EventFilter and the EventAction.
The compromised credentials risk configuration.
', ], ], 'ConcurrentModificationException' => [ 'base' => 'This exception is thrown if two or more modifications are happening concurrently.
', 'refs' => [], ], 'ConfirmDeviceRequest' => [ 'base' => 'Confirms the device request.
', 'refs' => [], ], 'ConfirmDeviceResponse' => [ 'base' => 'Confirms the device response.
', 'refs' => [], ], 'ConfirmForgotPasswordRequest' => [ 'base' => 'The request representing the confirmation for a password reset.
', 'refs' => [], ], 'ConfirmForgotPasswordResponse' => [ 'base' => 'The response from the server that results from a user\'s request to retrieve a forgotten password.
', 'refs' => [], ], 'ConfirmSignUpRequest' => [ 'base' => 'Represents the request to confirm registration of a user.
', 'refs' => [], ], 'ConfirmSignUpResponse' => [ 'base' => 'Represents the response from the server for the registration confirmation.
', 'refs' => [], ], 'ConfirmationCodeType' => [ 'base' => NULL, 'refs' => [ 'ConfirmForgotPasswordRequest$ConfirmationCode' => 'The confirmation code from your user\'s request to reset their password. For more information, see ForgotPassword.
', 'ConfirmSignUpRequest$ConfirmationCode' => 'The confirmation code sent by a user\'s request to confirm registration.
', 'VerifyUserAttributeRequest$Code' => 'The verification code in the request to verify user attributes.
', ], ], 'ContextDataType' => [ 'base' => 'Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
', 'refs' => [ 'AdminInitiateAuthRequest$ContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'AdminRespondToAuthChallengeRequest$ContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', ], ], 'CreateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIdentityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIdentityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResourceServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResourceServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserImportJobRequest' => [ 'base' => 'Represents the request to create the user import job.
', 'refs' => [], ], 'CreateUserImportJobResponse' => [ 'base' => 'Represents the response from the server to the request to create the user import job.
', 'refs' => [], ], 'CreateUserPoolClientRequest' => [ 'base' => 'Represents the request to create a user pool client.
', 'refs' => [], ], 'CreateUserPoolClientResponse' => [ 'base' => 'Represents the response from the server to create a user pool client.
', 'refs' => [], ], 'CreateUserPoolDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserPoolDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserPoolRequest' => [ 'base' => 'Represents the request to create a user pool.
', 'refs' => [], ], 'CreateUserPoolResponse' => [ 'base' => 'Represents the response from the server for the request to create a user pool.
', 'refs' => [], ], 'CustomAttributeNameType' => [ 'base' => NULL, 'refs' => [ 'SchemaAttributeType$Name' => 'The name of your user pool attribute, for example username or custom:costcenter.
An array of custom attributes, such as Mutable and Name.
', ], ], 'CustomDomainConfigType' => [ 'base' => 'The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
', 'refs' => [ 'CreateUserPoolDomainRequest$CustomDomainConfig' => 'The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
', 'DomainDescriptionType$CustomDomainConfig' => 'The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
', 'UpdateUserPoolDomainRequest$CustomDomainConfig' => 'The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
', ], ], 'CustomEmailLambdaVersionConfigType' => [ 'base' => 'A custom email sender Lambda configuration type.
', 'refs' => [ 'LambdaConfigType$CustomEmailSender' => 'A custom email sender Lambda trigger.
', ], ], 'CustomEmailSenderLambdaVersionType' => [ 'base' => NULL, 'refs' => [ 'CustomEmailLambdaVersionConfigType$LambdaVersion' => 'Signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0.
A custom SMS sender Lambda configuration type.
', 'refs' => [ 'LambdaConfigType$CustomSMSSender' => 'A custom SMS sender Lambda trigger.
', ], ], 'CustomSMSSenderLambdaVersionType' => [ 'base' => NULL, 'refs' => [ 'CustomSMSLambdaVersionConfigType$LambdaVersion' => 'Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.
The date the user was created.
', 'AdminGetUserResponse$UserLastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', 'AuthEventType$CreationDate' => 'The date and time, in ISO 8601 format, when the item was created.
', 'DeviceType$DeviceCreateDate' => 'The creation date of the device.
', 'DeviceType$DeviceLastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', 'DeviceType$DeviceLastAuthenticatedDate' => 'The date when the device was last authenticated.
', 'EventFeedbackType$FeedbackDate' => 'The event feedback date.
', 'GroupType$LastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', 'GroupType$CreationDate' => 'The date and time, in ISO 8601 format, when the item was created.
', 'IdentityProviderType$LastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', 'IdentityProviderType$CreationDate' => 'The date and time, in ISO 8601 format, when the item was created.
', 'ProviderDescription$LastModifiedDate' => 'The date the provider was last modified.
', 'ProviderDescription$CreationDate' => 'The date and time, in ISO 8601 format, when the item was created.
', 'RiskConfigurationType$LastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', 'UICustomizationType$LastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', 'UICustomizationType$CreationDate' => 'The date and time, in ISO 8601 format, when the item was created.
', 'UserImportJobType$CreationDate' => 'The date and time, in ISO 8601 format, when the item was created.
', 'UserImportJobType$StartDate' => 'The date when the user import job was started.
', 'UserImportJobType$CompletionDate' => 'The date when the user import job was completed.
', 'UserPoolClientType$LastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', 'UserPoolClientType$CreationDate' => 'The date and time, in ISO 8601 format, when the item was created.
', 'UserPoolDescriptionType$LastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', 'UserPoolDescriptionType$CreationDate' => 'The date and time, in ISO 8601 format, when the item was created.
', 'UserPoolType$LastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', 'UserPoolType$CreationDate' => 'The date and time, in ISO 8601 format, when the item was created.
', 'UserType$UserCreateDate' => 'The creation date of the user.
', 'UserType$UserLastModifiedDate' => 'The date and time, in ISO 8601 format, when the item was modified.
', ], ], 'DefaultEmailOptionType' => [ 'base' => NULL, 'refs' => [ 'VerificationMessageTemplateType$DefaultEmailOption' => 'The default email option.
', ], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIdentityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserAttributesRequest' => [ 'base' => 'Represents the request to delete user attributes.
', 'refs' => [], ], 'DeleteUserAttributesResponse' => [ 'base' => 'Represents the response from the server to delete user attributes.
', 'refs' => [], ], 'DeleteUserPoolClientRequest' => [ 'base' => 'Represents the request to delete a user pool client.
', 'refs' => [], ], 'DeleteUserPoolDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserPoolDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserPoolRequest' => [ 'base' => 'Represents the request to delete a user pool.
', 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => 'Represents the request to delete a user.
', 'refs' => [], ], 'DeletionProtectionType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$DeletionProtection' => 'When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". You can specify more than one value.
The method that Amazon Cognito used to send the code.
', 'DeliveryMediumListType$member' => NULL, 'MFAOptionType$DeliveryMedium' => 'The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.
Represents the request to describe the user import job.
', 'refs' => [], ], 'DescribeUserImportJobResponse' => [ 'base' => 'Represents the response from the server to the request to describe the user import job.
', 'refs' => [], ], 'DescribeUserPoolClientRequest' => [ 'base' => 'Represents the request to describe a user pool client.
', 'refs' => [], ], 'DescribeUserPoolClientResponse' => [ 'base' => 'Represents the response from the server from a request to describe the user pool client.
', 'refs' => [], ], 'DescribeUserPoolDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserPoolDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserPoolRequest' => [ 'base' => 'Represents the request to describe the user pool.
', 'refs' => [], ], 'DescribeUserPoolResponse' => [ 'base' => 'Represents the response to describe the user pool.
', 'refs' => [], ], 'DescriptionType' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$Description' => 'A string containing the description of the group.
', 'GroupType$Description' => 'A string containing the description of the group.
', 'UpdateGroupRequest$Description' => 'A string containing the new description of the group.
', ], ], 'DeviceConfigurationType' => [ 'base' => 'The device-remembering configuration for a user pool. A DescribeUserPool request returns a null value for this object when the user pool isn\'t configured to remember devices. When device remembering is active, you can remember a user\'s device with a ConfirmDevice API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt is true, you must follow ConfirmDevice with an UpdateDeviceStatus API request that sets the user\'s device to remembered or not_remembered.
To sign in with a remembered device, include DEVICE_KEY in the authentication parameters in your user\'s InitiateAuth request. If your app doesn\'t include a DEVICE_KEY parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY and DEVICE_GROUP_KEY values under NewDeviceMetadata. Store these values to use in future device-authentication requests.
When you provide a value for any property of DeviceConfiguration, you activate the device remembering for the user pool.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device key.
', 'AdminGetDeviceRequest$DeviceKey' => 'The device key.
', 'AdminUpdateDeviceStatusRequest$DeviceKey' => 'The device key.
', 'ConfirmDeviceRequest$DeviceKey' => 'The device key.
', 'DeviceType$DeviceKey' => 'The device key.
', 'ForgetDeviceRequest$DeviceKey' => 'The device key.
', 'GetDeviceRequest$DeviceKey' => 'The device key.
', 'NewDeviceMetadataType$DeviceKey' => 'The device key.
', 'UpdateDeviceStatusRequest$DeviceKey' => 'The device key.
', ], ], 'DeviceListType' => [ 'base' => NULL, 'refs' => [ 'AdminListDevicesResponse$Devices' => 'The devices in the list of devices response.
', 'ListDevicesResponse$Devices' => 'The devices returned in the list devices response.
', ], ], 'DeviceNameType' => [ 'base' => NULL, 'refs' => [ 'ConfirmDeviceRequest$DeviceName' => 'The device name.
', ], ], 'DeviceRememberedStatusType' => [ 'base' => NULL, 'refs' => [ 'AdminUpdateDeviceStatusRequest$DeviceRememberedStatus' => 'The status indicating whether a device has been remembered or not.
', 'UpdateDeviceStatusRequest$DeviceRememberedStatus' => 'The status of whether a device is remembered.
', ], ], 'DeviceSecretVerifierConfigType' => [ 'base' => 'The device verifier against which it is authenticated.
', 'refs' => [ 'ConfirmDeviceRequest$DeviceSecretVerifierConfig' => 'The configuration of the device secret verifier.
', ], ], 'DeviceType' => [ 'base' => 'The device type.
', 'refs' => [ 'AdminGetDeviceResponse$Device' => 'The device.
', 'DeviceListType$member' => NULL, 'GetDeviceResponse$Device' => 'The device.
', ], ], 'DomainDescriptionType' => [ 'base' => 'A container for information about a domain.
', 'refs' => [ 'DescribeUserPoolDomainResponse$DomainDescription' => 'A domain description object containing information about the domain.
', ], ], 'DomainStatusType' => [ 'base' => NULL, 'refs' => [ 'DomainDescriptionType$Status' => 'The domain status.
', ], ], 'DomainType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolDomainRequest$Domain' => 'The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
', 'DeleteUserPoolDomainRequest$Domain' => 'The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.
This string can include only lowercase letters, numbers, and hyphens. Don\'t use a hyphen for the first or last character. Use periods to separate subdomain names.
', 'UpdateUserPoolDomainResponse$CloudFrontDomain' => 'The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.
', 'UserPoolType$Domain' => 'The domain prefix, if the user pool has a domain associated with it.
', 'UserPoolType$CustomDomain' => 'A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
', ], ], 'DomainVersionType' => [ 'base' => NULL, 'refs' => [ 'DomainDescriptionType$Version' => 'The app version.
', ], ], 'DuplicateProviderException' => [ 'base' => 'This exception is thrown when the provider is already supported by the user pool.
', 'refs' => [], ], 'EmailAddressType' => [ 'base' => NULL, 'refs' => [ 'EmailConfigurationType$ReplyToEmailAddress' => 'The destination to which the receiver of the email should reply.
', ], ], 'EmailConfigurationType' => [ 'base' => 'The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see Email settings for Amazon Cognito user pools.
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
', 'UpdateUserPoolRequest$EmailConfiguration' => 'The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
', 'UserPoolType$EmailConfiguration' => 'The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
', ], ], 'EmailNotificationBodyType' => [ 'base' => NULL, 'refs' => [ 'NotifyEmailType$HtmlBody' => 'The email HTML body.
', 'NotifyEmailType$TextBody' => 'The email text body.
', ], ], 'EmailNotificationSubjectType' => [ 'base' => NULL, 'refs' => [ 'NotifyEmailType$Subject' => 'The email subject.
', ], ], 'EmailSendingAccountType' => [ 'base' => NULL, 'refs' => [ 'EmailConfigurationType$EmailSendingAccount' => 'Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide.
The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.
Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
This parameter is no longer used. See VerificationMessageTemplateType.
', 'MessageTemplateType$EmailMessage' => 'The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
', 'UpdateUserPoolRequest$EmailVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'UserPoolType$EmailVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'VerificationMessageTemplateType$EmailMessage' => 'The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
This parameter is no longer used. See VerificationMessageTemplateType.
', 'MessageTemplateType$EmailSubject' => 'The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
', 'UpdateUserPoolRequest$EmailVerificationSubject' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'UserPoolType$EmailVerificationSubject' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'VerificationMessageTemplateType$EmailSubject' => 'The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
', 'refs' => [], ], 'EventContextDataType' => [ 'base' => 'Specifies the user context data captured at the time of an event request.
', 'refs' => [ 'AuthEventType$EventContextData' => 'The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.
', ], ], 'EventFeedbackType' => [ 'base' => 'Specifies the event feedback type.
', 'refs' => [ 'AuthEventType$EventFeedback' => 'A flag specifying the user feedback captured at the time of an event request is good or bad.
', ], ], 'EventFilterType' => [ 'base' => NULL, 'refs' => [ 'EventFiltersType$member' => NULL, ], ], 'EventFiltersType' => [ 'base' => NULL, 'refs' => [ 'CompromisedCredentialsRiskConfigurationType$EventFilter' => 'Perform the action for these events. The default is to perform all events if no event filter is specified.
', ], ], 'EventIdType' => [ 'base' => NULL, 'refs' => [ 'AdminUpdateAuthEventFeedbackRequest$EventId' => 'The authentication event ID.
', 'UpdateAuthEventFeedbackRequest$EventId' => 'The event ID.
', ], ], 'EventResponseType' => [ 'base' => NULL, 'refs' => [ 'AuthEventType$EventResponse' => 'The event response.
', ], ], 'EventRiskType' => [ 'base' => 'The event risk type.
', 'refs' => [ 'AuthEventType$EventRisk' => 'The event risk.
', ], ], 'EventSourceName' => [ 'base' => NULL, 'refs' => [ 'LogConfigurationType$EventSource' => 'The source of events that your user pool sends for detailed activity logging.
', ], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'AuthEventType$EventType' => 'The event type.
', ], ], 'ExpiredCodeException' => [ 'base' => 'This exception is thrown if a code has expired.
', 'refs' => [], ], 'ExplicitAuthFlowsListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$ExplicitAuthFlows' => 'The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don\'t specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can\'t assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don\'t specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can\'t assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don\'t specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can\'t assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
The authentication event feedback value. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don\'t trust a user session, or you don\'t believe that Amazon Cognito evaluated a high-enough risk level.
The authentication event feedback value. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don\'t trust a user session, or you don\'t believe that Amazon Cognito evaluated a high-enough risk level.
The authentication event feedback value. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don\'t trust a user session, or you don\'t believe that Amazon Cognito evaluated a high-enough risk level.
This exception is thrown when WAF doesn\'t allow your request based on a web ACL that\'s associated with your user pool.
', 'refs' => [], ], 'ForceAliasCreation' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserRequest$ForceAliasCreation' => 'This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
Represents the request to forget the device.
', 'refs' => [], ], 'ForgotPasswordRequest' => [ 'base' => 'Represents the request to reset a user\'s password.
', 'refs' => [], ], 'ForgotPasswordResponse' => [ 'base' => 'The response from Amazon Cognito to a request to reset a password.
', 'refs' => [], ], 'GenerateSecret' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$GenerateSecret' => 'Boolean to specify whether you want to generate a secret for the user pool client being created.
', ], ], 'GetCSVHeaderRequest' => [ 'base' => 'Represents the request to get the header information of the CSV file for the user import job.
', 'refs' => [], ], 'GetCSVHeaderResponse' => [ 'base' => 'Represents the response from the server to the request to get the header information of the CSV file for the user import job.
', 'refs' => [], ], 'GetDeviceRequest' => [ 'base' => 'Represents the request to get the device.
', 'refs' => [], ], 'GetDeviceResponse' => [ 'base' => 'Gets the device response.
', 'refs' => [], ], 'GetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIdentityProviderByIdentifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIdentityProviderByIdentifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLogDeliveryConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLogDeliveryConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningCertificateRequest' => [ 'base' => 'Request to get a signing certificate from Amazon Cognito.
', 'refs' => [], ], 'GetSigningCertificateResponse' => [ 'base' => 'Response from Amazon Cognito for a signing certificate request.
', 'refs' => [], ], 'GetUICustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUICustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserAttributeVerificationCodeRequest' => [ 'base' => 'Represents the request to get user attribute verification.
', 'refs' => [], ], 'GetUserAttributeVerificationCodeResponse' => [ 'base' => 'The verification code response returned by the server response to get the user attribute verification code.
', 'refs' => [], ], 'GetUserPoolMfaConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserPoolMfaConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserRequest' => [ 'base' => 'Represents the request to get information about the user.
', 'refs' => [], ], 'GetUserResponse' => [ 'base' => 'Represents the response from the server from the request to get information about the user.
', 'refs' => [], ], 'GlobalSignOutRequest' => [ 'base' => 'Represents the request to sign out all devices.
', 'refs' => [], ], 'GlobalSignOutResponse' => [ 'base' => 'The response to the request to sign out all devices.
', 'refs' => [], ], 'GroupExistsException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
', 'refs' => [], ], 'GroupListType' => [ 'base' => NULL, 'refs' => [ 'AdminListGroupsForUserResponse$Groups' => 'The groups that the user belongs to.
', 'ListGroupsResponse$Groups' => 'The group objects for the groups.
', ], ], 'GroupNameType' => [ 'base' => NULL, 'refs' => [ 'AdminAddUserToGroupRequest$GroupName' => 'The group name.
', 'AdminRemoveUserFromGroupRequest$GroupName' => 'The group name.
', 'CreateGroupRequest$GroupName' => 'The name of the group. Must be unique.
', 'DeleteGroupRequest$GroupName' => 'The name of the group.
', 'GetGroupRequest$GroupName' => 'The name of the group.
', 'GroupType$GroupName' => 'The name of the group.
', 'ListUsersInGroupRequest$GroupName' => 'The name of the group.
', 'UpdateGroupRequest$GroupName' => 'The name of the group.
', ], ], 'GroupType' => [ 'base' => 'The group type.
', 'refs' => [ 'CreateGroupResponse$Group' => 'The group object for the group.
', 'GetGroupResponse$Group' => 'The group object for the group.
', 'GroupListType$member' => NULL, 'UpdateGroupResponse$Group' => 'The group object for the group.
', ], ], 'HexStringType' => [ 'base' => NULL, 'refs' => [ 'AnalyticsConfigurationType$ApplicationId' => 'The application ID for an Amazon Pinpoint application.
', ], ], 'HttpHeader' => [ 'base' => 'The HTTP header.
', 'refs' => [ 'HttpHeaderList$member' => NULL, ], ], 'HttpHeaderList' => [ 'base' => NULL, 'refs' => [ 'ContextDataType$HttpHeaders' => 'HttpHeaders received on your server in same order.
', ], ], 'IdTokenValidityType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$IdTokenValidity' => 'The ID token time limit. After this limit expires, your user can\'t use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
', 'UpdateUserPoolClientRequest$IdTokenValidity' => 'The ID token time limit. After this limit expires, your user can\'t use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
', 'UserPoolClientType$IdTokenValidity' => 'The ID token time limit. After this limit expires, your user can\'t use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
', ], ], 'IdentityProviderType' => [ 'base' => 'A container for information about an IdP.
', 'refs' => [ 'CreateIdentityProviderResponse$IdentityProvider' => 'The newly created IdP object.
', 'DescribeIdentityProviderResponse$IdentityProvider' => 'The identity provider details.
', 'GetIdentityProviderByIdentifierResponse$IdentityProvider' => 'The identity provider details.
', 'UpdateIdentityProviderResponse$IdentityProvider' => 'The identity provider details.
', ], ], 'IdentityProviderTypeType' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$ProviderType' => 'The IdP type.
', 'IdentityProviderType$ProviderType' => 'The IdP type.
', 'ProviderDescription$ProviderType' => 'The IdP type.
', ], ], 'IdpIdentifierType' => [ 'base' => NULL, 'refs' => [ 'GetIdentityProviderByIdentifierRequest$IdpIdentifier' => 'The IdP identifier.
', 'IdpIdentifiersListType$member' => NULL, ], ], 'IdpIdentifiersListType' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$IdpIdentifiers' => 'A list of IdP identifiers.
', 'IdentityProviderType$IdpIdentifiers' => 'A list of IdP identifiers.
', 'UpdateIdentityProviderRequest$IdpIdentifiers' => 'A list of IdP identifiers.
', ], ], 'ImageFileType' => [ 'base' => NULL, 'refs' => [ 'SetUICustomizationRequest$ImageFile' => 'The uploaded logo image for the UI customization.
', ], ], 'ImageUrlType' => [ 'base' => NULL, 'refs' => [ 'UICustomizationType$ImageUrl' => 'The logo image for the UI customization.
', ], ], 'InitiateAuthRequest' => [ 'base' => 'Initiates the authentication request.
', 'refs' => [], ], 'InitiateAuthResponse' => [ 'base' => 'Initiates the authentication response.
', 'refs' => [], ], 'IntegerType' => [ 'base' => NULL, 'refs' => [ 'AuthenticationResultType$ExpiresIn' => 'The expiration period of the authentication result in seconds.
', 'UserPoolType$EstimatedNumberOfUsers' => 'A number estimating the size of the user pool.
', ], ], 'InternalErrorException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters an internal error.
', 'refs' => [], ], 'InvalidEmailRoleAccessPolicyException' => [ 'base' => 'This exception is thrown when Amazon Cognito isn\'t allowed to use your email identity. HTTP status code: 400.
', 'refs' => [], ], 'InvalidLambdaResponseException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
', 'refs' => [], ], 'InvalidOAuthFlowException' => [ 'base' => 'This exception is thrown when the specified OAuth flow is not valid.
', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => 'This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
', 'refs' => [], ], 'InvalidPasswordException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters an invalid password.
', 'refs' => [], ], 'InvalidSmsRoleAccessPolicyException' => [ 'base' => 'This exception is returned when the role provided for SMS configuration doesn\'t have permission to publish using Amazon SNS.
', 'refs' => [], ], 'InvalidSmsRoleTrustRelationshipException' => [ 'base' => 'This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don\'t trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
This exception is thrown when the user pool configuration is not valid.
', 'refs' => [], ], 'LambdaConfigType' => [ 'base' => 'Specifies the configuration for Lambda triggers.
', 'refs' => [ 'CreateUserPoolRequest$LambdaConfig' => 'The Lambda trigger configuration information for the new user pool.
In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
For more information on using the Lambda API to add permission, see AddPermission .
For adding permission using the CLI, see add-permission .
The Lambda configuration information from the request to update the user pool.
', 'UserPoolDescriptionType$LambdaConfig' => 'The Lambda configuration information in a user pool description.
', 'UserPoolType$LambdaConfig' => 'The Lambda triggers associated with the user pool.
', ], ], 'LimitExceededException' => [ 'base' => 'This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
', 'refs' => [], ], 'ListDevicesRequest' => [ 'base' => 'Represents the request to list the devices.
', 'refs' => [], ], 'ListDevicesResponse' => [ 'base' => 'Represents the response to list devices.
', 'refs' => [], ], 'ListGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityProvidersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityProvidersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListOfStringTypes' => [ 'base' => NULL, 'refs' => [ 'GetCSVHeaderResponse$CSVHeader' => 'The header information of the CSV file for the user import job.
', ], ], 'ListProvidersLimitType' => [ 'base' => NULL, 'refs' => [ 'ListIdentityProvidersRequest$MaxResults' => 'The maximum number of IdPs to return.
', ], ], 'ListResourceServersLimitType' => [ 'base' => NULL, 'refs' => [ 'ListResourceServersRequest$MaxResults' => 'The maximum number of resource servers to return.
', ], ], 'ListResourceServersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceServersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserImportJobsRequest' => [ 'base' => 'Represents the request to list the user import jobs.
', 'refs' => [], ], 'ListUserImportJobsResponse' => [ 'base' => 'Represents the response from the server to the request to list the user import jobs.
', 'refs' => [], ], 'ListUserPoolClientsRequest' => [ 'base' => 'Represents the request to list the user pool clients.
', 'refs' => [], ], 'ListUserPoolClientsResponse' => [ 'base' => 'Represents the response from the server that lists user pool clients.
', 'refs' => [], ], 'ListUserPoolsRequest' => [ 'base' => 'Represents the request to list user pools.
', 'refs' => [], ], 'ListUserPoolsResponse' => [ 'base' => 'Represents the response to list user pools.
', 'refs' => [], ], 'ListUsersInGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersInGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => 'Represents the request to list users.
', 'refs' => [], ], 'ListUsersResponse' => [ 'base' => 'The response from the request to list users.
', 'refs' => [], ], 'LogConfigurationListType' => [ 'base' => NULL, 'refs' => [ 'LogDeliveryConfigurationType$LogConfigurations' => 'The detailed activity logging destination of a user pool.
', 'SetLogDeliveryConfigurationRequest$LogConfigurations' => 'A collection of all of the detailed activity logging configurations for a user pool.
', ], ], 'LogConfigurationType' => [ 'base' => 'The logging parameters of a user pool.
', 'refs' => [ 'LogConfigurationListType$member' => NULL, ], ], 'LogDeliveryConfigurationType' => [ 'base' => 'The logging parameters of a user pool.
', 'refs' => [ 'GetLogDeliveryConfigurationResponse$LogDeliveryConfiguration' => 'The detailed activity logging configuration of the requested user pool.
', 'SetLogDeliveryConfigurationResponse$LogDeliveryConfiguration' => 'The detailed activity logging configuration that you applied to the requested user pool.
', ], ], 'LogLevel' => [ 'base' => NULL, 'refs' => [ 'LogConfigurationType$LogLevel' => 'The errorlevel selection of logs that a user pool sends for detailed activity logging.
A list of allowed logout URLs for the IdPs.
', 'UpdateUserPoolClientRequest$LogoutURLs' => 'A list of allowed logout URLs for the IdPs.
', 'UserPoolClientType$LogoutURLs' => 'A list of allowed logout URLs for the IdPs.
', ], ], 'LongType' => [ 'base' => NULL, 'refs' => [ 'UserImportJobType$ImportedUsers' => 'The number of users that were successfully imported.
', 'UserImportJobType$SkippedUsers' => 'The number of users that were skipped.
', 'UserImportJobType$FailedUsers' => 'The number of users that couldn\'t be imported.
', ], ], 'MFAMethodNotFoundException' => [ 'base' => 'This exception is thrown when Amazon Cognito can\'t find a multi-factor authentication (MFA) method.
', 'refs' => [], ], 'MFAOptionListType' => [ 'base' => NULL, 'refs' => [ 'AdminGetUserResponse$MFAOptions' => 'This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn\'t provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
', 'AdminSetUserSettingsRequest$MFAOptions' => 'You can use this parameter only to set an SMS configuration that uses SMS for delivery.
', 'GetUserResponse$MFAOptions' => 'This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn\'t provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
', 'SetUserSettingsRequest$MFAOptions' => 'You can use this parameter only to set an SMS configuration that uses SMS for delivery.
', 'UserType$MFAOptions' => 'The MFA options for the user.
', ], ], 'MFAOptionType' => [ 'base' => 'This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.
', 'refs' => [ 'MFAOptionListType$member' => NULL, ], ], 'MessageActionType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserRequest$MessageAction' => 'Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user\'s account. Set to SUPPRESS to suppress sending the message. You can specify only one value.
The message template structure.
', 'refs' => [ 'AdminCreateUserConfigType$InviteMessageTemplate' => 'The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
', ], ], 'MessageType' => [ 'base' => NULL, 'refs' => [ 'AliasExistsException$message' => 'The message that Amazon Cognito sends to the user when the value of an alias attribute is already linked to another user profile.
', 'CodeDeliveryFailureException$message' => 'The message sent when a verification code fails to deliver successfully.
', 'CodeMismatchException$message' => 'The message provided when the code mismatch exception is thrown.
', 'ConcurrentModificationException$message' => 'The message provided when the concurrent exception is thrown.
', 'DuplicateProviderException$message' => NULL, 'EnableSoftwareTokenMFAException$message' => NULL, 'ExpiredCodeException$message' => 'The message returned when the expired code exception is thrown.
', 'ForbiddenException$message' => 'The message returned when WAF doesn\'t allow your request based on a web ACL that\'s associated with your user pool.
', 'GroupExistsException$message' => NULL, 'InternalErrorException$message' => 'The message returned when Amazon Cognito throws an internal error exception.
', 'InvalidEmailRoleAccessPolicyException$message' => 'The message returned when you have an unverified email address or the identity policy isn\'t set on an email address that Amazon Cognito can access.
', 'InvalidLambdaResponseException$message' => 'The message returned when Amazon Cognito throws an invalid Lambda response exception.
', 'InvalidOAuthFlowException$message' => NULL, 'InvalidParameterException$message' => 'The message returned when the Amazon Cognito service throws an invalid parameter exception.
', 'InvalidPasswordException$message' => 'The message returned when Amazon Cognito throws an invalid user password exception.
', 'InvalidSmsRoleAccessPolicyException$message' => 'The message returned when the invalid SMS role access policy exception is thrown.
', 'InvalidSmsRoleTrustRelationshipException$message' => 'The message returned when the role trust relationship for the SMS message is not valid.
', 'InvalidUserPoolConfigurationException$message' => 'The message returned when the user pool configuration is not valid.
', 'LimitExceededException$message' => 'The message returned when Amazon Cognito throws a limit exceeded exception.
', 'MFAMethodNotFoundException$message' => 'The message returned when Amazon Cognito throws an MFA method not found exception.
', 'NotAuthorizedException$message' => 'The message returned when the Amazon Cognito service returns a not authorized exception.
', 'PasswordResetRequiredException$message' => 'The message returned when a password reset is required.
', 'PreconditionNotMetException$message' => 'The message returned when a precondition is not met.
', 'ResourceNotFoundException$message' => 'The message returned when the Amazon Cognito service returns a resource not found exception.
', 'ScopeDoesNotExistException$message' => NULL, 'SoftwareTokenMFANotFoundException$message' => NULL, 'TooManyFailedAttemptsException$message' => 'The message returned when Amazon Cognito returns a TooManyFailedAttempts exception.
The message returned when the Amazon Cognito service returns a too many requests exception.
', 'UnauthorizedException$message' => NULL, 'UnexpectedLambdaException$message' => 'The message returned when Amazon Cognito returns an unexpected Lambda exception.
', 'UnsupportedIdentityProviderException$message' => NULL, 'UnsupportedOperationException$message' => NULL, 'UnsupportedTokenTypeException$message' => NULL, 'UnsupportedUserStateException$message' => 'The message returned when the user is in an unsupported state.
', 'UserImportInProgressException$message' => 'The message returned when the user pool has an import job running.
', 'UserLambdaValidationException$message' => 'The message returned when the Amazon Cognito service returns a user validation exception with the Lambda service.
', 'UserNotConfirmedException$message' => 'The message returned when a user isn\'t confirmed successfully.
', 'UserNotFoundException$message' => 'The message returned when a user isn\'t found.
', 'UserPoolAddOnNotEnabledException$message' => NULL, 'UserPoolTaggingException$message' => NULL, 'UsernameExistsException$message' => 'The message returned when Amazon Cognito throws a user name exists exception.
', ], ], 'NewDeviceMetadataType' => [ 'base' => 'The new device metadata type.
', 'refs' => [ 'AuthenticationResultType$NewDeviceMetadata' => 'The new device metadata from an authentication result.
', ], ], 'NotAuthorizedException' => [ 'base' => 'This exception is thrown when a user isn\'t authorized.
', 'refs' => [], ], 'NotifyConfigurationType' => [ 'base' => 'The notify configuration type.
', 'refs' => [ 'AccountTakeoverRiskConfigurationType$NotifyConfiguration' => 'The notify configuration used to construct email notifications.
', ], ], 'NotifyEmailType' => [ 'base' => 'The notify email type.
', 'refs' => [ 'NotifyConfigurationType$BlockEmail' => 'Email template used when a detected risk event is blocked.
', 'NotifyConfigurationType$NoActionEmail' => 'The email template used when a detected risk event is allowed.
', 'NotifyConfigurationType$MfaEmail' => 'The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.
', ], ], 'NumberAttributeConstraintsType' => [ 'base' => 'The minimum and maximum values of an attribute that is of the number data type.
', 'refs' => [ 'SchemaAttributeType$NumberAttributeConstraints' => 'Specifies the constraints for an attribute of the number type.
', ], ], 'OAuthFlowType' => [ 'base' => NULL, 'refs' => [ 'OAuthFlowsType$member' => NULL, ], ], 'OAuthFlowsType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$AllowedOAuthFlows' => 'The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'AdminListGroupsForUserResponse$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'AdminListUserAuthEventsRequest$NextToken' => 'A pagination token.
', 'AdminListUserAuthEventsResponse$NextToken' => 'A pagination token.
', 'ListGroupsRequest$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListGroupsResponse$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUserPoolClientsRequest$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUserPoolClientsResponse$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUsersInGroupRequest$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUsersInGroupResponse$NextToken' => 'An identifier that you can use in a later request to return the next set of items in the list.
', ], ], 'PaginationKeyType' => [ 'base' => NULL, 'refs' => [ 'ListIdentityProvidersRequest$NextToken' => 'A pagination token.
', 'ListIdentityProvidersResponse$NextToken' => 'A pagination token.
', 'ListResourceServersRequest$NextToken' => 'A pagination token.
', 'ListResourceServersResponse$NextToken' => 'A pagination token.
', 'ListUserImportJobsRequest$PaginationToken' => 'An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.
An identifier that can be used to return the next set of user import jobs in the list.
', 'ListUserPoolsRequest$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUserPoolsResponse$NextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', ], ], 'PasswordPolicyMinLengthType' => [ 'base' => NULL, 'refs' => [ 'PasswordPolicyType$MinimumLength' => 'The minimum length of the password in the policy that you have set. This value can\'t be less than 6.
', ], ], 'PasswordPolicyType' => [ 'base' => 'The password policy type.
', 'refs' => [ 'UserPoolPolicyType$PasswordPolicy' => 'The password policy.
', ], ], 'PasswordResetRequiredException' => [ 'base' => 'This exception is thrown when a password reset is required.
', 'refs' => [], ], 'PasswordType' => [ 'base' => NULL, 'refs' => [ 'AdminCreateUserRequest$TemporaryPassword' => 'The user\'s temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn\'t required. If you don\'t specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify RESEND for the MessageAction parameter.
The password for the user.
', 'ChangePasswordRequest$PreviousPassword' => 'The old password.
', 'ChangePasswordRequest$ProposedPassword' => 'The new password.
', 'ConfirmForgotPasswordRequest$Password' => 'The new password that your user wants to set.
', 'SignUpRequest$Password' => 'The password of the user you want to register.
', ], ], 'PoolQueryLimitType' => [ 'base' => NULL, 'refs' => [ 'ListUserImportJobsRequest$MaxResults' => 'The maximum number of import jobs you want the request to return.
', 'ListUserPoolsRequest$MaxResults' => 'The maximum number of results you want the request to return when listing the user pools.
', ], ], 'PreSignedUrlType' => [ 'base' => NULL, 'refs' => [ 'UserImportJobType$PreSignedUrl' => 'The pre-signed URL to be used to upload the .csv file.
A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user\'s tokens for the cognito:roles and cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn\'t set in users\' tokens.
The default Precedence value is null. The maximum Precedence value is 2^31-1.
A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher ornull Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user\'s tokens for the cognito:roles and cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn\'t set in users\' tokens.
The default Precedence value is null.
The new precedence value for the group. For more information about this parameter, see CreateGroup.
', ], ], 'PreconditionNotMetException' => [ 'base' => 'This exception is thrown when a precondition is not met.
', 'refs' => [], ], 'PreventUserExistenceErrorTypes' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$PreventUserExistenceErrors' => 'Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn\'t exist in the user pool. When set to ENABLED and the user doesn\'t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn\'t exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren\'t prevented.
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn\'t exist in the user pool. When set to ENABLED and the user doesn\'t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn\'t exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren\'t prevented.
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn\'t exist in the user pool. When set to ENABLED and the user doesn\'t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn\'t exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren\'t prevented.
A positive integer specifying priority of a method with 1 being the highest priority.
', ], ], 'ProviderDescription' => [ 'base' => 'A container for IdP details.
', 'refs' => [ 'ProvidersListType$member' => NULL, ], ], 'ProviderDetailsType' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$ProviderDetails' => 'The IdP details. The following list describes the provider detail keys for each IdP type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OpenID Connect (OIDC) providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
The following keys are only present if Amazon Cognito didn\'t discover them at the oidc_issuer URL.
authorize_url
token_url
attributes_url
jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
attributes_url_add_attributes
For SAML providers:
MetadataFile or MetadataURL
IDPSignout optional
The IdP details. The following list describes the provider detail keys for each IdP type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
You can submit a private_key when you add or update an IdP. Describe operations don\'t return the private key.
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
The following keys are only present if Amazon Cognito didn\'t discover them at the oidc_issuer URL.
authorize_url
token_url
attributes_url
jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
attributes_url_add_attributes
For SAML providers:
MetadataFile or MetadataURL
IDPSignout optional
The IdP details to be updated, such as MetadataURL and MetadataFile.
The IdP name.
', 'DescribeIdentityProviderRequest$ProviderName' => 'The IdP name.
', 'IdentityProviderType$ProviderName' => 'The IdP name.
', 'ProviderDescription$ProviderName' => 'The IdP name.
', 'ProviderUserIdentifierType$ProviderName' => 'The name of the provider, such as Facebook, Google, or Login with Amazon.
', 'SupportedIdentityProvidersListType$member' => NULL, 'UpdateIdentityProviderRequest$ProviderName' => 'The IdP name.
', ], ], 'ProviderNameTypeV1' => [ 'base' => NULL, 'refs' => [ 'CreateIdentityProviderRequest$ProviderName' => 'The IdP name.
', ], ], 'ProviderUserIdentifierType' => [ 'base' => 'A container for information about an IdP for a user pool.
', 'refs' => [ 'AdminDisableProviderForUserRequest$User' => 'The user to be disabled.
', 'AdminLinkProviderForUserRequest$DestinationUser' => 'The existing user in the user pool that you want to assign to the external IdP user account. This user can be a local (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn\'t exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.
For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.
The ProviderAttributeName of the DestinationUser is ignored.
The ProviderName should be set to Cognito for users in Cognito user pools.
All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won\'t succeed.
An external IdP account for a user who doesn\'t exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
If the SourceUser is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social IdP token.
For OIDC, the ProviderAttributeName can be any value that matches a claim in the ID token, or that your app retrieves from the userInfo endpoint. You must map the claim to a user pool attribute in your IdP configuration, and set the user pool attribute name as the value of ProviderAttributeName in your AdminLinkProviderForUser request.
For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. To link SAML users based on the subject of the SAML assertion, map the subject to a claim through the SAML IdP and set that claim name as the value of ProviderAttributeName in your AdminLinkProviderForUser request.
For both OIDC and SAML users, when you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the IdP token.
A list of IdP objects.
', ], ], 'QueryLimit' => [ 'base' => NULL, 'refs' => [ 'ListUserPoolClientsRequest$MaxResults' => 'The maximum number of results you want the request to return when listing the user pool clients.
', ], ], 'QueryLimitType' => [ 'base' => NULL, 'refs' => [ 'AdminListDevicesRequest$Limit' => 'The limit of the devices request.
', 'AdminListGroupsForUserRequest$Limit' => 'The limit of the request to list groups.
', 'AdminListUserAuthEventsRequest$MaxResults' => 'The maximum number of authentication events to return. Returns 60 events if you set MaxResults to 0, or if you don\'t include a MaxResults parameter.
The limit of the device request.
', 'ListGroupsRequest$Limit' => 'The limit of the request to list groups.
', 'ListUsersInGroupRequest$Limit' => 'The limit of the request to list users.
', 'ListUsersRequest$Limit' => 'Maximum number of users to be returned.
', ], ], 'RecoveryMechanismsType' => [ 'base' => NULL, 'refs' => [ 'AccountRecoverySettingType$RecoveryMechanisms' => 'The list of RecoveryOptionTypes.
The recovery method for a user.
', ], ], 'RecoveryOptionType' => [ 'base' => 'A map containing a priority as a key, and recovery method name as a value.
', 'refs' => [ 'RecoveryMechanismsType$member' => NULL, ], ], 'RedirectUrlType' => [ 'base' => NULL, 'refs' => [ 'CallbackURLsListType$member' => NULL, 'CreateUserPoolClientRequest$DefaultRedirectURI' => 'The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
', 'LogoutURLsListType$member' => NULL, 'UpdateUserPoolClientRequest$DefaultRedirectURI' => 'The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
', ], ], 'RefreshTokenValidityType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$RefreshTokenValidity' => 'The refresh token time limit. After this limit expires, your user can\'t use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. You can\'t set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
', 'UpdateUserPoolClientRequest$RefreshTokenValidity' => 'The refresh token time limit. After this limit expires, your user can\'t use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. You can\'t set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
', 'UserPoolClientType$RefreshTokenValidity' => 'The refresh token time limit. After this limit expires, your user can\'t use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. You can\'t set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don\'t specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
', ], ], 'RegionCodeType' => [ 'base' => NULL, 'refs' => [ 'SmsConfigurationType$SnsRegion' => 'The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.
Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
', ], ], 'ResendConfirmationCodeRequest' => [ 'base' => 'Represents the request to resend the confirmation code.
', 'refs' => [], ], 'ResendConfirmationCodeResponse' => [ 'base' => 'The response from the server when Amazon Cognito makes the request to resend a confirmation code.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'This exception is thrown when the Amazon Cognito service can\'t find the requested resource.
', 'refs' => [], ], 'ResourceServerIdentifierType' => [ 'base' => NULL, 'refs' => [ 'CreateResourceServerRequest$Identifier' => 'A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.
The identifier for the resource server.
', 'DescribeResourceServerRequest$Identifier' => 'The identifier for the resource server
', 'ResourceServerType$Identifier' => 'The identifier for the resource server.
', 'UpdateResourceServerRequest$Identifier' => 'The identifier for the resource server.
', ], ], 'ResourceServerNameType' => [ 'base' => NULL, 'refs' => [ 'CreateResourceServerRequest$Name' => 'A friendly name for the resource server.
', 'ResourceServerType$Name' => 'The name of the resource server.
', 'UpdateResourceServerRequest$Name' => 'The name of the resource server.
', ], ], 'ResourceServerScopeDescriptionType' => [ 'base' => NULL, 'refs' => [ 'ResourceServerScopeType$ScopeDescription' => 'A description of the scope.
', ], ], 'ResourceServerScopeListType' => [ 'base' => NULL, 'refs' => [ 'CreateResourceServerRequest$Scopes' => 'A list of scopes. Each scope is a key-value map with the keys name and description.
A list of scopes that are defined for the resource server.
', 'UpdateResourceServerRequest$Scopes' => 'The scope values to be set for the resource server.
', ], ], 'ResourceServerScopeNameType' => [ 'base' => NULL, 'refs' => [ 'ResourceServerScopeType$ScopeName' => 'The name of the scope.
', ], ], 'ResourceServerScopeType' => [ 'base' => 'A resource server scope.
', 'refs' => [ 'ResourceServerScopeListType$member' => NULL, ], ], 'ResourceServerType' => [ 'base' => 'A container for information about a resource server for a user pool.
', 'refs' => [ 'CreateResourceServerResponse$ResourceServer' => 'The newly created resource server.
', 'DescribeResourceServerResponse$ResourceServer' => 'The resource server.
', 'ResourceServersListType$member' => NULL, 'UpdateResourceServerResponse$ResourceServer' => 'The resource server.
', ], ], 'ResourceServersListType' => [ 'base' => NULL, 'refs' => [ 'ListResourceServersResponse$ResourceServers' => 'The resource servers.
', ], ], 'RespondToAuthChallengeRequest' => [ 'base' => 'The request to respond to an authentication challenge.
', 'refs' => [], ], 'RespondToAuthChallengeResponse' => [ 'base' => 'The response to respond to the authentication challenge.
', 'refs' => [], ], 'RevokeTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeTokenResponse' => [ 'base' => NULL, 'refs' => [], ], 'RiskConfigurationType' => [ 'base' => 'The risk configuration type.
', 'refs' => [ 'DescribeRiskConfigurationResponse$RiskConfiguration' => 'The risk configuration.
', 'SetRiskConfigurationResponse$RiskConfiguration' => 'The risk configuration.
', ], ], 'RiskDecisionType' => [ 'base' => NULL, 'refs' => [ 'EventRiskType$RiskDecision' => 'The risk decision.
', ], ], 'RiskExceptionConfigurationType' => [ 'base' => 'The type of the configuration to override the risk decision.
', 'refs' => [ 'RiskConfigurationType$RiskExceptionConfiguration' => 'The configuration to override the risk decision.
', 'SetRiskConfigurationRequest$RiskExceptionConfiguration' => 'The configuration to override the risk decision.
', ], ], 'RiskLevelType' => [ 'base' => NULL, 'refs' => [ 'EventRiskType$RiskLevel' => 'The risk level.
', ], ], 'S3BucketType' => [ 'base' => NULL, 'refs' => [ 'DomainDescriptionType$S3Bucket' => 'The Amazon S3 bucket where the static files for this domain are stored.
', ], ], 'SESConfigurationSet' => [ 'base' => NULL, 'refs' => [ 'EmailConfigurationType$ConfigurationSet' => 'The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:
Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don\'t need to be verified to be used for SMS MFA. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
', 'refs' => [ 'AdminSetUserMFAPreferenceRequest$SMSMfaSettings' => 'The SMS text message MFA settings.
', 'SetUserMFAPreferenceRequest$SMSMfaSettings' => 'The SMS text message multi-factor authentication (MFA) settings.
', ], ], 'SchemaAttributeType' => [ 'base' => 'A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
', 'refs' => [ 'CustomAttributesListType$member' => NULL, 'SchemaAttributesListType$member' => NULL, ], ], 'SchemaAttributesListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$Schema' => 'An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
', 'UserPoolType$SchemaAttributes' => 'A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
', ], ], 'ScopeDoesNotExistException' => [ 'base' => 'This exception is thrown when the specified scope doesn\'t exist.
', 'refs' => [], ], 'ScopeListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$AllowedOAuthScopes' => 'The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
The pagination token.
', 'AdminListDevicesResponse$PaginationToken' => 'The pagination token.
', 'ListDevicesRequest$PaginationToken' => 'The pagination token for the list request.
', 'ListDevicesResponse$PaginationToken' => 'The pagination token for the list device response.
', 'ListUsersRequest$PaginationToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUsersResponse$PaginationToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', ], ], 'SearchedAttributeNamesListType' => [ 'base' => NULL, 'refs' => [ 'ListUsersRequest$AttributesToGet' => 'A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to include in the response for each user. When you don\'t provide an AttributesToGet parameter, Amazon Cognito returns all attributes for each user.
A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.
', ], ], 'SecretHashType' => [ 'base' => NULL, 'refs' => [ 'ConfirmForgotPasswordRequest$SecretHash' => 'A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about SecretHash, see Computing secret hash values.
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
', 'ForgotPasswordRequest$SecretHash' => 'A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
', 'ResendConfirmationCodeRequest$SecretHash' => 'A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
', 'SignUpRequest$SecretHash' => 'A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
', ], ], 'SessionType' => [ 'base' => NULL, 'refs' => [ 'AdminInitiateAuthResponse$Session' => 'The session that should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
', 'AssociateSoftwareTokenResponse$Session' => 'The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
', 'InitiateAuthResponse$Session' => 'The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
The session that should be passed both ways in challenge-response calls to the service.
', 'VerifySoftwareTokenResponse$Session' => 'The session that should be passed both ways in challenge-response calls to the service.
', ], ], 'SetLogDeliveryConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetLogDeliveryConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'SetRiskConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetRiskConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'SetUICustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetUICustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'SetUserMFAPreferenceRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetUserMFAPreferenceResponse' => [ 'base' => NULL, 'refs' => [], ], 'SetUserPoolMfaConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetUserPoolMfaConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'SetUserSettingsRequest' => [ 'base' => 'Represents the request to set user settings.
', 'refs' => [], ], 'SetUserSettingsResponse' => [ 'base' => 'The response from the server for a set user settings request.
', 'refs' => [], ], 'SignUpRequest' => [ 'base' => 'Represents the request to register a user.
', 'refs' => [], ], 'SignUpResponse' => [ 'base' => 'The response from the server for a registration request.
', 'refs' => [], ], 'SkippedIPRangeListType' => [ 'base' => NULL, 'refs' => [ 'RiskExceptionConfigurationType$SkippedIPRangeList' => 'Risk detection isn\'t performed on the IP addresses in this range list. The IP range is in CIDR notation.
', ], ], 'SmsConfigurationType' => [ 'base' => 'The SMS configuration type is the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
', 'refs' => [ 'CreateUserPoolRequest$SmsConfiguration' => 'The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
', 'SmsMfaConfigType$SmsConfiguration' => 'The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.
', 'UpdateUserPoolRequest$SmsConfiguration' => 'The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
', 'UserPoolType$SmsConfiguration' => 'The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
', ], ], 'SmsMfaConfigType' => [ 'base' => 'The SMS text message multi-factor authentication (MFA) configuration type.
', 'refs' => [ 'GetUserPoolMfaConfigResponse$SmsMfaConfiguration' => 'The SMS text message multi-factor authentication (MFA) configuration.
', 'SetUserPoolMfaConfigRequest$SmsMfaConfiguration' => 'The SMS text message MFA configuration.
', 'SetUserPoolMfaConfigResponse$SmsMfaConfiguration' => 'The SMS text message MFA configuration.
', ], ], 'SmsVerificationMessageType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$SmsVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'CreateUserPoolRequest$SmsAuthenticationMessage' => 'A string representing the SMS authentication message.
', 'MessageTemplateType$SMSMessage' => 'The message template for SMS messages.
', 'SmsMfaConfigType$SmsAuthenticationMessage' => 'The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn\'t included, and default message will be used.
', 'UpdateUserPoolRequest$SmsVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'UpdateUserPoolRequest$SmsAuthenticationMessage' => 'The contents of the SMS authentication message.
', 'UserPoolType$SmsVerificationMessage' => 'This parameter is no longer used. See VerificationMessageTemplateType.
', 'UserPoolType$SmsAuthenticationMessage' => 'The contents of the SMS authentication message.
', 'VerificationMessageTemplateType$SmsMessage' => 'The template for SMS messages that Amazon Cognito sends to your users.
', ], ], 'SoftwareTokenMFANotFoundException' => [ 'base' => 'This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn\'t activated for the user pool.
', 'refs' => [], ], 'SoftwareTokenMFAUserCodeType' => [ 'base' => NULL, 'refs' => [ 'VerifySoftwareTokenRequest$UserCode' => 'The one- time password computed using the secret code returned by AssociateSoftwareToken.
', ], ], 'SoftwareTokenMfaConfigType' => [ 'base' => 'The type used for enabling software token MFA at the user pool level.
', 'refs' => [ 'GetUserPoolMfaConfigResponse$SoftwareTokenMfaConfiguration' => 'The software token multi-factor authentication (MFA) configuration.
', 'SetUserPoolMfaConfigRequest$SoftwareTokenMfaConfiguration' => 'The software token MFA configuration.
', 'SetUserPoolMfaConfigResponse$SoftwareTokenMfaConfiguration' => 'The software token MFA configuration.
', ], ], 'SoftwareTokenMfaSettingsType' => [ 'base' => 'The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
', 'refs' => [ 'AdminSetUserMFAPreferenceRequest$SoftwareTokenMfaSettings' => 'The time-based one-time password software token MFA settings.
', 'SetUserMFAPreferenceRequest$SoftwareTokenMfaSettings' => 'The time-based one-time password (TOTP) software token MFA settings.
', ], ], 'StartUserImportJobRequest' => [ 'base' => 'Represents the request to start the user import job.
', 'refs' => [], ], 'StartUserImportJobResponse' => [ 'base' => 'Represents the response from the server to the request to start the user import job.
', 'refs' => [], ], 'StatusType' => [ 'base' => NULL, 'refs' => [ 'UserPoolDescriptionType$Status' => 'The user pool status in a user pool description.
', 'UserPoolType$Status' => 'The status of a user pool.
', ], ], 'StopUserImportJobRequest' => [ 'base' => 'Represents the request to stop the user import job.
', 'refs' => [], ], 'StopUserImportJobResponse' => [ 'base' => 'Represents the response from the server to the request to stop the user import job.
', 'refs' => [], ], 'StringAttributeConstraintsType' => [ 'base' => 'The constraints associated with a string attribute.
', 'refs' => [ 'SchemaAttributeType$StringAttributeConstraints' => 'Specifies the constraints for an attribute of the string type.
', ], ], 'StringType' => [ 'base' => NULL, 'refs' => [ 'AdminDisableProviderForUserRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AdminGetUserResponse$PreferredMfaSetting' => 'The user\'s preferred MFA setting.
', 'AdminLinkProviderForUserRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AnalyticsConfigurationType$ExternalId' => 'The external ID.
', 'AnalyticsMetadataType$AnalyticsEndpointId' => 'The endpoint ID.
', 'AttributeMappingType$value' => NULL, 'AuthEventType$EventId' => 'The event ID.
', 'AuthParametersType$key' => NULL, 'AuthParametersType$value' => NULL, 'AuthenticationResultType$TokenType' => 'The token type.
', 'BlockedIPRangeListType$member' => NULL, 'ChallengeParametersType$key' => NULL, 'ChallengeParametersType$value' => NULL, 'ChallengeResponsesType$key' => NULL, 'ChallengeResponsesType$value' => NULL, 'ClientMetadataType$key' => NULL, 'ClientMetadataType$value' => NULL, 'CodeDeliveryDetailsType$Destination' => 'The email address or phone number destination where Amazon Cognito sent the code.
', 'ContextDataType$IpAddress' => 'The source IP address of your user\'s device.
', 'ContextDataType$ServerName' => 'Your server endpoint where this API is invoked.
', 'ContextDataType$ServerPath' => 'Your server path where this API is invoked.
', 'ContextDataType$EncodedData' => 'Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
', 'DeviceSecretVerifierConfigType$PasswordVerifier' => 'The password verifier.
', 'DeviceSecretVerifierConfigType$Salt' => 'The salt
', 'DomainDescriptionType$CloudFrontDistribution' => 'The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
', 'EmailConfigurationType$From' => 'Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.
The source IP address of your user\'s device.
', 'EventContextDataType$DeviceName' => 'The user\'s device name.
', 'EventContextDataType$Timezone' => 'The user\'s time zone.
', 'EventContextDataType$City' => 'The user\'s city.
', 'EventContextDataType$Country' => 'The user\'s country.
', 'EventFeedbackType$Provider' => 'The provider.
', 'GetSigningCertificateResponse$Certificate' => 'The signing certificate.
', 'GetUserResponse$PreferredMfaSetting' => 'The user\'s preferred MFA setting.
', 'HttpHeader$headerName' => 'The header name.
', 'HttpHeader$headerValue' => 'The header value.
', 'ListOfStringTypes$member' => NULL, 'NewDeviceMetadataType$DeviceGroupKey' => 'The device group key.
', 'NotifyConfigurationType$From' => 'The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
', 'NotifyConfigurationType$ReplyTo' => 'The destination to which the receiver of an email should reply to.
', 'NumberAttributeConstraintsType$MinValue' => 'The minimum value of an attribute that is of the number data type.
', 'NumberAttributeConstraintsType$MaxValue' => 'The maximum value of an attribute that is of the number data type.
', 'ProviderDetailsType$key' => NULL, 'ProviderDetailsType$value' => NULL, 'ProviderUserIdentifierType$ProviderAttributeName' => 'The name of the provider attribute to link to, such as NameID.
The value of the provider attribute to link to, such as xxxxx_account.
The UUID of the authenticated user. This isn\'t the same as username.
The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.
For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party
The minimum length.
', 'StringAttributeConstraintsType$MaxLength' => 'The maximum length.
', 'UserContextDataType$IpAddress' => 'The source IP address of your user\'s device.
', 'UserContextDataType$EncodedData' => 'Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
', 'UserMFASettingListType$member' => NULL, 'UserPoolType$SmsConfigurationFailure' => 'The reason why the SMS configuration can\'t send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can\'t send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn\'t properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.
The friendly device name.
', ], ], 'SupportedIdentityProvidersListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$SupportedIdentityProviders' => 'A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.
A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.
A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.
The number of days a temporary password is valid in the password policy. If the user doesn\'t sign in during this time, an administrator must reset their password.
When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.
A time unit of seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours. AccessTokenValidity duration can range from five minutes to one day.
A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours. IdTokenValidity duration can range from five minutes to one day.
A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days. RefreshTokenValidity duration can range from 60 minutes to 10 years.
A valid access token that Amazon Cognito issued to the user whose software token you want to generate.
', 'AuthenticationResultType$AccessToken' => 'A valid access token that Amazon Cognito issued to the user who you want to authenticate.
', 'AuthenticationResultType$RefreshToken' => 'The refresh token.
', 'AuthenticationResultType$IdToken' => 'The ID token.
', 'ChangePasswordRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose password you want to change.
', 'ConfirmDeviceRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
', 'DeleteUserAttributesRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
', 'DeleteUserRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.
', 'ForgetDeviceRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.
', 'GetDeviceRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose device information you want to request.
', 'GetUserAttributeVerificationCodeRequest$AccessToken' => 'A non-expired access token for the user whose attribute verification code you want to generate.
', 'GetUserRequest$AccessToken' => 'A non-expired access token for the user whose information you want to query.
', 'GlobalSignOutRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user who you want to sign out.
', 'ListDevicesRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
', 'RevokeTokenRequest$Token' => 'The refresh token that you want to revoke.
', 'SetUserMFAPreferenceRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
', 'SetUserSettingsRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
', 'UpdateAuthEventFeedbackRequest$FeedbackToken' => 'The feedback token.
', 'UpdateDeviceStatusRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose device status you want to update.
', 'UpdateUserAttributesRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
', 'VerifySoftwareTokenRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose software token you want to verify.
', 'VerifyUserAttributeRequest$AccessToken' => 'A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
', ], ], 'TokenValidityUnitsType' => [ 'base' => 'The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.
', 'refs' => [ 'CreateUserPoolClientRequest$TokenValidityUnits' => 'The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
', 'UpdateUserPoolClientRequest$TokenValidityUnits' => 'The time units you use when you set the duration of ID, access, and refresh tokens. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
', 'UserPoolClientType$TokenValidityUnits' => 'The time units used to specify the token validity times of each token type: ID, access, and refresh.
', ], ], 'TooManyFailedAttemptsException' => [ 'base' => 'This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
', 'refs' => [], ], 'TooManyRequestsException' => [ 'base' => 'This exception is thrown when the user has made too many requests for a given operation.
', 'refs' => [], ], 'UICustomizationType' => [ 'base' => 'A container for the UI customization information for a user pool\'s built-in app UI.
', 'refs' => [ 'GetUICustomizationResponse$UICustomization' => 'The UI customization information.
', 'SetUICustomizationResponse$UICustomization' => 'The UI customization information.
', ], ], 'UnauthorizedException' => [ 'base' => 'Exception that is thrown when the request isn\'t authorized. This can happen due to an invalid access token in the request.
', 'refs' => [], ], 'UnexpectedLambdaException' => [ 'base' => 'This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
', 'refs' => [], ], 'UnsupportedIdentityProviderException' => [ 'base' => 'This exception is thrown when the specified identifier isn\'t supported.
', 'refs' => [], ], 'UnsupportedOperationException' => [ 'base' => 'Exception that is thrown when you attempt to perform an operation that isn\'t enabled for the user pool client.
', 'refs' => [], ], 'UnsupportedTokenTypeException' => [ 'base' => 'Exception that is thrown when an unsupported token is passed to an operation.
', 'refs' => [], ], 'UnsupportedUserStateException' => [ 'base' => 'The request failed because the user is in an unsupported state.
', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAuthEventFeedbackRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAuthEventFeedbackResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceStatusRequest' => [ 'base' => 'Represents the request to update the device status.
', 'refs' => [], ], 'UpdateDeviceStatusResponse' => [ 'base' => 'The response to the request to update the device status.
', 'refs' => [], ], 'UpdateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIdentityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIdentityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourceServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourceServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserAttributesRequest' => [ 'base' => 'Represents the request to update user attributes.
', 'refs' => [], ], 'UpdateUserAttributesResponse' => [ 'base' => 'Represents the response from the server for the request to update user attributes.
', 'refs' => [], ], 'UpdateUserPoolClientRequest' => [ 'base' => 'Represents the request to update the user pool client.
', 'refs' => [], ], 'UpdateUserPoolClientResponse' => [ 'base' => 'Represents the response from the server to the request to update the user pool client.
', 'refs' => [], ], 'UpdateUserPoolDomainRequest' => [ 'base' => 'The UpdateUserPoolDomain request input.
', 'refs' => [], ], 'UpdateUserPoolDomainResponse' => [ 'base' => 'The UpdateUserPoolDomain response output.
', 'refs' => [], ], 'UpdateUserPoolRequest' => [ 'base' => 'Represents the request to update the user pool.
', 'refs' => [], ], 'UpdateUserPoolResponse' => [ 'base' => 'Represents the response from the server when you make a request to update the user pool.
', 'refs' => [], ], 'UserAttributeUpdateSettingsType' => [ 'base' => 'The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users\' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users\' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users\' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users\' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
Contextual data, such as the user\'s device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
', 'refs' => [ 'ConfirmForgotPasswordRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'ConfirmSignUpRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'ForgotPasswordRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'InitiateAuthRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'ResendConfirmationCodeRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'RespondToAuthChallengeRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', 'SignUpRequest$UserContextData' => 'Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
', ], ], 'UserFilterType' => [ 'base' => NULL, 'refs' => [ 'ListUsersRequest$Filter' => 'A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\\) character. For example, "family_name = \\"Reddy\\"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "given_name = \\"Jon\\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \\"Jon\\"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers returns all users in the user pool.
You can only search for the following standard attributes:
username (case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status (called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes aren\'t searchable.
You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
', ], ], 'UserImportInProgressException' => [ 'base' => 'This exception is thrown when you\'re trying to modify a user pool while a user import job is in progress for that pool.
', 'refs' => [], ], 'UserImportJobIdType' => [ 'base' => NULL, 'refs' => [ 'DescribeUserImportJobRequest$JobId' => 'The job ID for the user import job.
', 'StartUserImportJobRequest$JobId' => 'The job ID for the user import job.
', 'StopUserImportJobRequest$JobId' => 'The job ID for the user import job.
', 'UserImportJobType$JobId' => 'The job ID for the user import job.
', ], ], 'UserImportJobNameType' => [ 'base' => NULL, 'refs' => [ 'CreateUserImportJobRequest$JobName' => 'The job name for the user import job.
', 'UserImportJobType$JobName' => 'The job name for the user import job.
', ], ], 'UserImportJobStatusType' => [ 'base' => NULL, 'refs' => [ 'UserImportJobType$Status' => 'The status of the user import job. One of the following:
Created - The job was created but not started.
Pending - A transition state. You have started the job, but it has not begun importing users yet.
InProgress - The job has started, and users are being imported.
Stopping - You have stopped the job, but the job has not stopped importing users yet.
Stopped - You have stopped the job, and the job has stopped importing users.
Succeeded - The job has completed successfully.
Failed - The job has stopped due to an error.
Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can\'t be started.
The user import job type.
', 'refs' => [ 'CreateUserImportJobResponse$UserImportJob' => 'The job object that represents the user import job.
', 'DescribeUserImportJobResponse$UserImportJob' => 'The job object that represents the user import job.
', 'StartUserImportJobResponse$UserImportJob' => 'The job object that represents the user import job.
', 'StopUserImportJobResponse$UserImportJob' => 'The job object that represents the user import job.
', 'UserImportJobsListType$member' => NULL, ], ], 'UserImportJobsListType' => [ 'base' => NULL, 'refs' => [ 'ListUserImportJobsResponse$UserImportJobs' => 'The user import jobs.
', ], ], 'UserLambdaValidationException' => [ 'base' => 'This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
', 'refs' => [], ], 'UserMFASettingListType' => [ 'base' => NULL, 'refs' => [ 'AdminGetUserResponse$UserMFASettingList' => 'The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
This exception is thrown when a user isn\'t confirmed successfully.
', 'refs' => [], ], 'UserNotFoundException' => [ 'base' => 'This exception is thrown when a user isn\'t found.
', 'refs' => [], ], 'UserPoolAddOnNotEnabledException' => [ 'base' => 'This exception is thrown when user pool add-ons aren\'t enabled.
', 'refs' => [], ], 'UserPoolAddOnsType' => [ 'base' => 'User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
', 'refs' => [ 'CreateUserPoolRequest$UserPoolAddOns' => 'User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
', 'UpdateUserPoolRequest$UserPoolAddOns' => 'User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
', 'UserPoolType$UserPoolAddOns' => 'User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
', ], ], 'UserPoolClientDescription' => [ 'base' => 'The description of the user pool client.
', 'refs' => [ 'UserPoolClientListType$member' => NULL, ], ], 'UserPoolClientListType' => [ 'base' => NULL, 'refs' => [ 'ListUserPoolClientsResponse$UserPoolClients' => 'The user pool clients in the response that lists user pool clients.
', ], ], 'UserPoolClientType' => [ 'base' => 'Contains information about a user pool client.
', 'refs' => [ 'CreateUserPoolClientResponse$UserPoolClient' => 'The user pool client that was just created.
', 'DescribeUserPoolClientResponse$UserPoolClient' => 'The user pool client from a server response to describe the user pool client.
', 'UpdateUserPoolClientResponse$UserPoolClient' => 'The user pool client value from the response from the server when you request to update the user pool client.
', ], ], 'UserPoolDescriptionType' => [ 'base' => 'A user pool description.
', 'refs' => [ 'UserPoolListType$member' => NULL, ], ], 'UserPoolIdType' => [ 'base' => NULL, 'refs' => [ 'AddCustomAttributesRequest$UserPoolId' => 'The user pool ID for the user pool where you want to add custom attributes.
', 'AdminAddUserToGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AdminConfirmSignUpRequest$UserPoolId' => 'The user pool ID for which you want to confirm user registration.
', 'AdminCreateUserRequest$UserPoolId' => 'The user pool ID for the user pool where the user will be created.
', 'AdminDeleteUserAttributesRequest$UserPoolId' => 'The user pool ID for the user pool where you want to delete user attributes.
', 'AdminDeleteUserRequest$UserPoolId' => 'The user pool ID for the user pool where you want to delete the user.
', 'AdminDisableUserRequest$UserPoolId' => 'The user pool ID for the user pool where you want to disable the user.
', 'AdminEnableUserRequest$UserPoolId' => 'The user pool ID for the user pool where you want to enable the user.
', 'AdminForgetDeviceRequest$UserPoolId' => 'The user pool ID.
', 'AdminGetDeviceRequest$UserPoolId' => 'The user pool ID.
', 'AdminGetUserRequest$UserPoolId' => 'The user pool ID for the user pool where you want to get information about the user.
', 'AdminInitiateAuthRequest$UserPoolId' => 'The ID of the Amazon Cognito user pool.
', 'AdminListDevicesRequest$UserPoolId' => 'The user pool ID.
', 'AdminListGroupsForUserRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AdminListUserAuthEventsRequest$UserPoolId' => 'The user pool ID.
', 'AdminRemoveUserFromGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'AdminResetUserPasswordRequest$UserPoolId' => 'The user pool ID for the user pool where you want to reset the user\'s password.
', 'AdminRespondToAuthChallengeRequest$UserPoolId' => 'The ID of the Amazon Cognito user pool.
', 'AdminSetUserMFAPreferenceRequest$UserPoolId' => 'The user pool ID.
', 'AdminSetUserPasswordRequest$UserPoolId' => 'The user pool ID for the user pool where you want to set the user\'s password.
', 'AdminSetUserSettingsRequest$UserPoolId' => 'The ID of the user pool that contains the user whose options you\'re setting.
', 'AdminUpdateAuthEventFeedbackRequest$UserPoolId' => 'The user pool ID.
', 'AdminUpdateDeviceStatusRequest$UserPoolId' => 'The user pool ID.
', 'AdminUpdateUserAttributesRequest$UserPoolId' => 'The user pool ID for the user pool where you want to update user attributes.
', 'AdminUserGlobalSignOutRequest$UserPoolId' => 'The user pool ID.
', 'CreateGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'CreateIdentityProviderRequest$UserPoolId' => 'The user pool ID.
', 'CreateResourceServerRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'CreateUserImportJobRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'CreateUserPoolClientRequest$UserPoolId' => 'The user pool ID for the user pool where you want to create a user pool client.
', 'CreateUserPoolDomainRequest$UserPoolId' => 'The user pool ID.
', 'DeleteGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'DeleteIdentityProviderRequest$UserPoolId' => 'The user pool ID.
', 'DeleteResourceServerRequest$UserPoolId' => 'The user pool ID for the user pool that hosts the resource server.
', 'DeleteUserPoolClientRequest$UserPoolId' => 'The user pool ID for the user pool where you want to delete the client.
', 'DeleteUserPoolDomainRequest$UserPoolId' => 'The user pool ID.
', 'DeleteUserPoolRequest$UserPoolId' => 'The user pool ID for the user pool you want to delete.
', 'DescribeIdentityProviderRequest$UserPoolId' => 'The user pool ID.
', 'DescribeResourceServerRequest$UserPoolId' => 'The user pool ID for the user pool that hosts the resource server.
', 'DescribeRiskConfigurationRequest$UserPoolId' => 'The user pool ID.
', 'DescribeUserImportJobRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'DescribeUserPoolClientRequest$UserPoolId' => 'The user pool ID for the user pool you want to describe.
', 'DescribeUserPoolRequest$UserPoolId' => 'The user pool ID for the user pool you want to describe.
', 'DomainDescriptionType$UserPoolId' => 'The user pool ID.
', 'GetCSVHeaderRequest$UserPoolId' => 'The user pool ID for the user pool that the users are to be imported into.
', 'GetCSVHeaderResponse$UserPoolId' => 'The user pool ID for the user pool that the users are to be imported into.
', 'GetGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'GetIdentityProviderByIdentifierRequest$UserPoolId' => 'The user pool ID.
', 'GetLogDeliveryConfigurationRequest$UserPoolId' => 'The ID of the user pool where you want to view detailed activity logging configuration.
', 'GetSigningCertificateRequest$UserPoolId' => 'The user pool ID.
', 'GetUICustomizationRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'GetUserPoolMfaConfigRequest$UserPoolId' => 'The user pool ID.
', 'GroupType$UserPoolId' => 'The user pool ID for the user pool.
', 'IdentityProviderType$UserPoolId' => 'The user pool ID.
', 'ListGroupsRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'ListIdentityProvidersRequest$UserPoolId' => 'The user pool ID.
', 'ListResourceServersRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'ListUserImportJobsRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'ListUserPoolClientsRequest$UserPoolId' => 'The user pool ID for the user pool where you want to list user pool clients.
', 'ListUsersInGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'ListUsersRequest$UserPoolId' => 'The user pool ID for the user pool on which the search should be performed.
', 'LogDeliveryConfigurationType$UserPoolId' => 'The ID of the user pool where you configured detailed activity logging.
', 'ResourceServerType$UserPoolId' => 'The user pool ID for the user pool that hosts the resource server.
', 'RiskConfigurationType$UserPoolId' => 'The user pool ID.
', 'SetLogDeliveryConfigurationRequest$UserPoolId' => 'The ID of the user pool where you want to configure detailed activity logging .
', 'SetRiskConfigurationRequest$UserPoolId' => 'The user pool ID.
', 'SetUICustomizationRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'SetUserPoolMfaConfigRequest$UserPoolId' => 'The user pool ID.
', 'StartUserImportJobRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'StopUserImportJobRequest$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'UICustomizationType$UserPoolId' => 'The user pool ID for the user pool.
', 'UpdateAuthEventFeedbackRequest$UserPoolId' => 'The user pool ID.
', 'UpdateGroupRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'UpdateIdentityProviderRequest$UserPoolId' => 'The user pool ID.
', 'UpdateResourceServerRequest$UserPoolId' => 'The user pool ID for the user pool.
', 'UpdateUserPoolClientRequest$UserPoolId' => 'The user pool ID for the user pool where you want to update the user pool client.
', 'UpdateUserPoolDomainRequest$UserPoolId' => 'The ID of the user pool that is associated with the custom domain whose certificate you\'re updating.
', 'UpdateUserPoolRequest$UserPoolId' => 'The user pool ID for the user pool you want to update.
', 'UserImportJobType$UserPoolId' => 'The user pool ID for the user pool that the users are being imported into.
', 'UserPoolClientDescription$UserPoolId' => 'The user pool ID for the user pool where you want to describe the user pool client.
', 'UserPoolClientType$UserPoolId' => 'The user pool ID for the user pool client.
', 'UserPoolDescriptionType$Id' => 'The ID in a user pool description.
', 'UserPoolType$Id' => 'The ID of the user pool.
', ], ], 'UserPoolListType' => [ 'base' => NULL, 'refs' => [ 'ListUserPoolsResponse$UserPools' => 'The user pools from the response to list users.
', ], ], 'UserPoolMfaType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$MfaConfiguration' => 'Specifies MFA configuration details.
', 'GetUserPoolMfaConfigResponse$MfaConfiguration' => 'The multi-factor authentication (MFA) configuration. Valid values include:
OFF MFA won\'t be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
OFF MFA won\'t be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
The MFA configuration. Valid values include:
OFF MFA won\'t be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
Possible values include:
OFF - MFA tokens aren\'t required and can\'t be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify ON when you\'re initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
Can be one of the following values:
OFF - MFA tokens aren\'t required and can\'t be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required when you\'re initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.
A string used to name the user pool.
', 'UserPoolDescriptionType$Name' => 'The name in a user pool description.
', 'UserPoolType$Name' => 'The name of the user pool.
', ], ], 'UserPoolPolicyType' => [ 'base' => 'The policy associated with a user pool.
', 'refs' => [ 'CreateUserPoolRequest$Policies' => 'The policies associated with the new user pool.
', 'UpdateUserPoolRequest$Policies' => 'A container with the policies you want to update in a user pool.
', 'UserPoolType$Policies' => 'The policies associated with the user pool.
', ], ], 'UserPoolTaggingException' => [ 'base' => 'This exception is thrown when a user pool tag can\'t be set or updated.
', 'refs' => [], ], 'UserPoolTagsListType' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'The keys of the tags to remove from the user pool.
', ], ], 'UserPoolTagsType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$UserPoolTags' => 'The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
', 'ListTagsForResourceResponse$Tags' => 'The tags that are assigned to the user pool.
', 'TagResourceRequest$Tags' => 'The tags to assign to the user pool.
', 'UpdateUserPoolRequest$UserPoolTags' => 'The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
', 'UserPoolType$UserPoolTags' => 'The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
', ], ], 'UserPoolType' => [ 'base' => 'A container for information about the user pool.
', 'refs' => [ 'CreateUserPoolResponse$UserPool' => 'A container for the user pool details.
', 'DescribeUserPoolResponse$UserPool' => 'The container of metadata returned by the server to describe the pool.
', ], ], 'UserStatusType' => [ 'base' => NULL, 'refs' => [ 'AdminGetUserResponse$UserStatus' => 'The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
UNKNOWN - User status isn\'t known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn\'t known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
A user profile in a Amazon Cognito user pool.
', 'refs' => [ 'AdminCreateUserResponse$User' => 'The newly created user.
', 'UsersListType$member' => NULL, ], ], 'UsernameAttributeType' => [ 'base' => NULL, 'refs' => [ 'UsernameAttributesListType$member' => NULL, ], ], 'UsernameAttributesListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$UsernameAttributes' => 'Specifies whether a user can use an email address or phone number as a username when they sign up.
', 'UserPoolType$UsernameAttributes' => 'Specifies whether a user can use an email address or phone number as a username when they sign up.
', ], ], 'UsernameConfigurationType' => [ 'base' => 'The username configuration type.
', 'refs' => [ 'CreateUserPoolRequest$UsernameConfiguration' => 'Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
', 'UserPoolType$UsernameConfiguration' => 'Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
', 'refs' => [], ], 'UsernameType' => [ 'base' => NULL, 'refs' => [ 'AdminAddUserToGroupRequest$Username' => 'The username for the user.
', 'AdminConfirmSignUpRequest$Username' => 'The user name for which you want to confirm user registration.
', 'AdminCreateUserRequest$Username' => 'The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can\'t be changed.
', 'AdminDeleteUserAttributesRequest$Username' => 'The user name of the user from which you would like to delete attributes.
', 'AdminDeleteUserRequest$Username' => 'The user name of the user you want to delete.
', 'AdminDisableUserRequest$Username' => 'The user name of the user you want to disable.
', 'AdminEnableUserRequest$Username' => 'The user name of the user you want to enable.
', 'AdminForgetDeviceRequest$Username' => 'The user name.
', 'AdminGetDeviceRequest$Username' => 'The user name.
', 'AdminGetUserRequest$Username' => 'The user name of the user you want to retrieve.
', 'AdminGetUserResponse$Username' => 'The username of the user that you requested.
', 'AdminListDevicesRequest$Username' => 'The user name.
', 'AdminListGroupsForUserRequest$Username' => 'The username for the user.
', 'AdminListUserAuthEventsRequest$Username' => 'The user pool username or an alias.
', 'AdminRemoveUserFromGroupRequest$Username' => 'The username for the user.
', 'AdminResetUserPasswordRequest$Username' => 'The user name of the user whose password you want to reset.
', 'AdminSetUserMFAPreferenceRequest$Username' => 'The user pool username or alias.
', 'AdminSetUserPasswordRequest$Username' => 'The user name of the user whose password you want to set.
', 'AdminSetUserSettingsRequest$Username' => 'The user name of the user whose options you\'re setting.
', 'AdminUpdateAuthEventFeedbackRequest$Username' => 'The user pool username.
', 'AdminUpdateDeviceStatusRequest$Username' => 'The user name.
', 'AdminUpdateUserAttributesRequest$Username' => 'The user name of the user for whom you want to update user attributes.
', 'AdminUserGlobalSignOutRequest$Username' => 'The user name.
', 'ConfirmForgotPasswordRequest$Username' => 'The user name of the user for whom you want to enter a code to retrieve a forgotten password.
', 'ConfirmSignUpRequest$Username' => 'The user name of the user whose registration you want to confirm.
', 'ForgotPasswordRequest$Username' => 'The user name of the user for whom you want to enter a code to reset a forgotten password.
', 'GetUserResponse$Username' => 'The username of the user that you requested.
', 'ResendConfirmationCodeRequest$Username' => 'The username attribute of the user to whom you want to resend a confirmation code.
The user name of the user you want to register.
', 'UpdateAuthEventFeedbackRequest$Username' => 'The user pool username.
', 'UserType$Username' => 'The user name of the user you want to describe.
', ], ], 'UsersListType' => [ 'base' => NULL, 'refs' => [ 'ListUsersInGroupResponse$Users' => 'The users returned in the request to list users.
', 'ListUsersResponse$Users' => 'A list of the user pool users, and their attributes, that match your query.
Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.
The template for verification messages.
', 'refs' => [ 'CreateUserPoolRequest$VerificationMessageTemplate' => 'The template for the verification message that the user sees when the app requests permission to access the user\'s information.
', 'UpdateUserPoolRequest$VerificationMessageTemplate' => 'The template for verification messages.
', 'UserPoolType$VerificationMessageTemplate' => 'The template for verification messages.
', ], ], 'VerifiedAttributeType' => [ 'base' => NULL, 'refs' => [ 'AttributesRequireVerificationBeforeUpdateType$member' => NULL, 'VerifiedAttributesListType$member' => NULL, ], ], 'VerifiedAttributesListType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolRequest$AutoVerifiedAttributes' => 'The attributes to be auto-verified. Possible values: email, phone_number.
', 'UpdateUserPoolRequest$AutoVerifiedAttributes' => 'The attributes that are automatically verified when Amazon Cognito requests to update user pools.
', 'UserPoolType$AutoVerifiedAttributes' => 'The attributes that are auto-verified in a user pool.
', ], ], 'VerifySoftwareTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'VerifySoftwareTokenResponse' => [ 'base' => NULL, 'refs' => [], ], 'VerifySoftwareTokenResponseType' => [ 'base' => NULL, 'refs' => [ 'VerifySoftwareTokenResponse$Status' => 'The status of the verify software token.
', ], ], 'VerifyUserAttributeRequest' => [ 'base' => 'Represents the request to verify user attributes.
', 'refs' => [], ], 'VerifyUserAttributeResponse' => [ 'base' => 'A container representing the response from the server from the request to verify user attributes.
', 'refs' => [], ], 'WrappedBooleanType' => [ 'base' => NULL, 'refs' => [ 'CreateUserPoolClientRequest$EnableTokenRevocation' => 'Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don\'t include this parameter, token revocation is automatically activated for the new user pool client.
', 'CreateUserPoolClientRequest$EnablePropagateAdditionalUserContextData' => 'Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can\'t send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Indicates whether compromised credentials were detected during an authentication event.
', 'UpdateUserPoolClientRequest$EnableTokenRevocation' => 'Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
', 'UpdateUserPoolClientRequest$EnablePropagateAdditionalUserContextData' => 'Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can\'t send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
', 'UserPoolClientType$EnablePropagateAdditionalUserContextData' => 'When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
When EnablePropagateAdditionalUserContextData is false, you can\'t send your user\'s source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn\'t affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.
Valid values include:
Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using username, USERNAME, or UserName. This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.
These key-value pairs define parameters for the connection:
HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME - The name under which to log in to the database. The value string for USER_NAME is \"USERNAME\".
PASSWORD - A password, if one is used, for the user name.
ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
JDBC_ENGINE - The name of the JDBC engine to use.
JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
CONFIG_FILES - (Reserved for future use.)
INSTANCE_ID - The instance ID to use.
JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.
CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.
SECRET_ID - The secret ID used for the secret manager of credentials.
CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.
CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.
CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.
KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".
KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".
KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).
KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_MECHANISM - \"SCRAM-SHA-512\", \"GSSAPI\", or \"AWS_MSK_IAM\". These are the supported SASL Mechanisms.
KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.
KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
These key-value pairs define parameters for the connection:
HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME - The name under which to log in to the database. The value string for USER_NAME is \"USERNAME\".
PASSWORD - A password, if one is used, for the user name.
ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
JDBC_ENGINE - The name of the JDBC engine to use.
JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
CONFIG_FILES - (Reserved for future use.)
INSTANCE_ID - The instance ID to use.
JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.
CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.
SECRET_ID - The secret ID used for the secret manager of credentials.
CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.
CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.
CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.
KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".
KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".
KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).
KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_MECHANISM - \"SCRAM-SHA-512\", \"GSSAPI\", or \"AWS_MSK_IAM\". These are the supported SASL Mechanisms.
KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.
KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN - The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
These key-value pairs define parameters for the connection.
" } }, diff --git a/src/data/glue/2017-03-31/docs-2.json.php b/src/data/glue/2017-03-31/docs-2.json.php index 2c7120258a..d8b6081c47 100644 --- a/src/data/glue/2017-03-31/docs-2.json.php +++ b/src/data/glue/2017-03-31/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Defines the public endpoint for the Glue service.
', 'operations' => [ 'BatchCreatePartition' => 'Creates one or more partitions in a batch operation.
', 'BatchDeleteConnection' => 'Deletes a list of connection definitions from the Data Catalog.
', 'BatchDeletePartition' => 'Deletes one or more partitions in a batch operation.
', 'BatchDeleteTable' => 'Deletes multiple tables at once.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.
Deletes a specified batch of versions of a table.
', 'BatchGetBlueprints' => 'Retrieves information about a list of blueprints.
', 'BatchGetCrawlers' => 'Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves the details for the custom patterns specified by a list of names.
', 'BatchGetDataQualityResult' => 'Retrieves a list of data quality results for the specified result IDs.
', 'BatchGetDevEndpoints' => 'Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves partitions in a batch request.
', 'BatchGetTriggers' => 'Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Stops one or more job runs for a specified job definition.
', 'BatchUpdatePartition' => 'Updates one or more partitions in a batch operation.
', 'CancelDataQualityRuleRecommendationRun' => 'Cancels the specified recommendation run that was being used to generate rules.
', 'CancelDataQualityRulesetEvaluationRun' => 'Cancels a run where a ruleset is being evaluated against a data source.
', 'CancelMLTaskRun' => 'Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling CancelMLTaskRun with a task run\'s parent transform\'s TransformID and the task run\'s TaskRunId.
Cancels the statement.
', 'CheckSchemaVersionValidity' => 'Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat as the format. Since it does not take a schema set name, no compatibility checks are performed.
Registers a blueprint with Glue.
', 'CreateClassifier' => 'Creates a classifier in the user\'s account. This can be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present.
Creates a connection definition in the Data Catalog.
', 'CreateCrawler' => 'Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.
', 'CreateDataQualityRuleset' => 'Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.
', 'CreateDatabase' => 'Creates a new database in a Data Catalog.
', 'CreateDevEndpoint' => 'Creates a new development endpoint.
', 'CreateJob' => 'Creates a new job definition.
', 'CreateMLTransform' => 'Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.
Call this operation as the first step in the process of using a machine learning transform (such as the FindMatches transform) for deduplicating data. You can provide an optional Description, in addition to the parameters that you want to use for your algorithm.
You must also specify certain parameters for the tasks that Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include Role, and optionally, AllocatedCapacity, Timeout, and MaxRetries. For more information, see Jobs.
Creates a new partition.
', 'CreatePartitionIndex' => 'Creates a specified partition index in an existing table.
', 'CreateRegistry' => 'Creates a new registry which may be used to hold a collection of schemas.
', 'CreateSchema' => 'Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.
When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion API is used.
When this API is called without a RegistryId, this will create an entry for a "default-registry" in the registry database tables, if it is not already present.
Transforms a directed acyclic graph (DAG) into code.
', 'CreateSecurityConfiguration' => 'Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.
', 'CreateSession' => 'Creates a new session.
', 'CreateTable' => 'Creates a new table definition in the Data Catalog.
', 'CreateTrigger' => 'Creates a new trigger.
', 'CreateUserDefinedFunction' => 'Creates a new function definition in the Data Catalog.
', 'CreateWorkflow' => 'Creates a new workflow.
', 'DeleteBlueprint' => 'Deletes an existing blueprint.
', 'DeleteClassifier' => 'Removes a classifier from the Data Catalog.
', 'DeleteColumnStatisticsForPartition' => 'Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is DeletePartition.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is DeleteTable.
Deletes a connection from the Data Catalog.
', 'DeleteCrawler' => 'Removes a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING.
Deletes a custom pattern by specifying its name.
', 'DeleteDataQualityRuleset' => 'Deletes a data quality ruleset.
', 'DeleteDatabase' => 'Removes a specified database from a Data Catalog.
After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database.
Deletes a specified development endpoint.
', 'DeleteJob' => 'Deletes a specified job definition. If the job definition is not found, no exception is thrown.
', 'DeleteMLTransform' => 'Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms. However, any Glue jobs that still reference the deleted transform will no longer succeed.
Deletes a specified partition.
', 'DeletePartitionIndex' => 'Deletes a specified partition index from an existing table.
', 'DeleteRegistry' => 'Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.
Deletes a specified policy.
', 'DeleteSchema' => 'Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.
Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions.
When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API.
You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database.
If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.
', 'DeleteSecurityConfiguration' => 'Deletes a specified security configuration.
', 'DeleteSession' => 'Deletes the session.
', 'DeleteTable' => 'Removes a table definition from the Data Catalog.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.
Deletes a specified version of a table.
', 'DeleteTrigger' => 'Deletes a specified trigger. If the trigger is not found, no exception is thrown.
', 'DeleteUserDefinedFunction' => 'Deletes an existing function definition from the Data Catalog.
', 'DeleteWorkflow' => 'Deletes a workflow.
', 'GetBlueprint' => 'Retrieves the details of a blueprint.
', 'GetBlueprintRun' => 'Retrieves the details of a blueprint run.
', 'GetBlueprintRuns' => 'Retrieves the details of blueprint runs for a specified blueprint.
', 'GetCatalogImportStatus' => 'Retrieves the status of a migration operation.
', 'GetClassifier' => 'Retrieve a classifier by name.
', 'GetClassifiers' => 'Lists all classifier objects in the Data Catalog.
', 'GetColumnStatisticsForPartition' => 'Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetPartition.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetTable.
Retrieves a connection definition from the Data Catalog.
', 'GetConnections' => 'Retrieves a list of connection definitions from the Data Catalog.
', 'GetCrawler' => 'Retrieves metadata for a specified crawler.
', 'GetCrawlerMetrics' => 'Retrieves metrics about specified crawlers.
', 'GetCrawlers' => 'Retrieves metadata for all crawlers defined in the customer account.
', 'GetCustomEntityType' => 'Retrieves the details of a custom pattern by specifying its name.
', 'GetDataCatalogEncryptionSettings' => 'Retrieves the security configuration for a specified catalog.
', 'GetDataQualityResult' => 'Retrieves the result of a data quality rule evaluation.
', 'GetDataQualityRuleRecommendationRun' => 'Gets the specified recommendation run that was used to generate rules.
', 'GetDataQualityRuleset' => 'Returns an existing ruleset by identifier or name.
', 'GetDataQualityRulesetEvaluationRun' => 'Retrieves a specific run where a ruleset is evaluated against a data source.
', 'GetDatabase' => 'Retrieves the definition of a specified database.
', 'GetDatabases' => 'Retrieves all databases defined in a given Data Catalog.
', 'GetDataflowGraph' => 'Transforms a Python script into a directed acyclic graph (DAG).
', 'GetDevEndpoint' => 'Retrieves information about a specified development endpoint.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Retrieves all the development endpoints in this Amazon Web Services account.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Retrieves an existing job definition.
', 'GetJobBookmark' => 'Returns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
', 'GetJobRun' => 'Retrieves the metadata for a given job run.
', 'GetJobRuns' => 'Retrieves metadata for all runs of a given job definition.
', 'GetJobs' => 'Retrieves all current job definitions.
', 'GetMLTaskRun' => 'Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling GetMLTaskRun with the TaskRunID and its parent transform\'s TransformID.
Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform\'s TransformID and other optional parameters as documented in this section.
This operation returns a list of historic runs and must be paginated.
', 'GetMLTransform' => 'Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling GetMLTransform.
Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling GetMLTransforms.
Creates mappings.
', 'GetPartition' => 'Retrieves information about a specified partition.
', 'GetPartitionIndexes' => 'Retrieves the partition indexes associated with a table.
', 'GetPartitions' => 'Retrieves information about the partitions in a table.
', 'GetPlan' => 'Gets code to perform a specified mapping.
', 'GetRegistry' => 'Describes the specified registry in detail.
', 'GetResourcePolicies' => 'Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy.
If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can\'t return the Data Catalog resource policy.
', 'GetResourcePolicy' => 'Retrieves a specified resource policy.
', 'GetSchema' => 'Describes the specified schema in detail.
', 'GetSchemaByDefinition' => 'Retrieves a schema by the SchemaDefinition. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of the SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted statuses will not be included in the results.
Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.
', 'GetSchemaVersionsDiff' => 'Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.
', 'GetSecurityConfiguration' => 'Retrieves a specified security configuration.
', 'GetSecurityConfigurations' => 'Retrieves a list of all security configurations.
', 'GetSession' => 'Retrieves the session.
', 'GetStatement' => 'Retrieves the statement.
', 'GetTable' => 'Retrieves the Table definition in a Data Catalog for a specified table.
Retrieves a specified version of a table.
', 'GetTableVersions' => 'Retrieves a list of strings that identify available versions of a specified table.
', 'GetTables' => 'Retrieves the definitions of some or all of the tables in a given Database.
Retrieves a list of tags associated with a resource.
', 'GetTrigger' => 'Retrieves the definition of a trigger.
', 'GetTriggers' => 'Gets all the triggers associated with a job.
', 'GetUnfilteredPartitionMetadata' => 'Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetPartition.
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetPartitions.
Retrieves table metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetTable.
Retrieves a specified function definition from the Data Catalog.
', 'GetUserDefinedFunctions' => 'Retrieves multiple function definitions from the Data Catalog.
', 'GetWorkflow' => 'Retrieves resource metadata for a workflow.
', 'GetWorkflowRun' => 'Retrieves the metadata for a given workflow run.
', 'GetWorkflowRunProperties' => 'Retrieves the workflow run properties which were set during the run.
', 'GetWorkflowRuns' => 'Retrieves metadata for all runs of a given workflow.
', 'ImportCatalogToGlue' => 'Imports an existing Amazon Athena Data Catalog to Glue.
', 'ListBlueprints' => 'Lists all the blueprint names in an account.
', 'ListCrawlers' => 'Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.
You may use this API to:
Retrive all the crawls of a specified crawler.
Retrieve all the crawls of a specified crawler within a limited count.
Retrieve all the crawls of a specified crawler in a specific time range.
Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.
Lists all the custom patterns that have been created.
', 'ListDataQualityResults' => 'Returns all data quality execution results for your account.
', 'ListDataQualityRuleRecommendationRuns' => 'Lists the recommendation runs meeting the filter criteria.
', 'ListDataQualityRulesetEvaluationRuns' => 'Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
', 'ListDataQualityRulesets' => 'Returns a paginated list of rulesets for the specified list of Glue tables.
', 'ListDevEndpoints' => 'Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.
Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available.
Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.
', 'ListSchemas' => 'Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.
When the RegistryId is not provided, all the schemas across registries will be part of the API response.
Retrieve a list of sessions.
', 'ListStatements' => 'Lists statements for the session.
', 'ListTriggers' => 'Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Lists names of workflows created in the account.
', 'PutDataCatalogEncryptionSettings' => 'Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.
', 'PutResourcePolicy' => 'Sets the Data Catalog resource policy for access control.
', 'PutSchemaVersionMetadata' => 'Puts the metadata key value pair for a specified schema version ID. A maximum of 10 key value pairs will be allowed per schema version. They can be added over one or more calls.
', 'PutWorkflowRunProperties' => 'Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.
', 'QuerySchemaVersionMetadata' => 'Queries for the schema version metadata information.
', 'RegisterSchemaVersion' => 'Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.
If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.
If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.
', 'RemoveSchemaVersionMetadata' => 'Removes a key value pair from the schema version metadata for the specified schema version ID.
', 'ResetJobBookmark' => 'Resets a bookmark entry.
For more information about enabling and using job bookmarks, see:
', 'ResumeWorkflowRun' => 'Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run.
', 'RunStatement' => 'Executes the statement.
', 'SearchTables' => 'Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.
', 'StartBlueprintRun' => 'Starts a new run of the specified blueprint.
', 'StartCrawler' => 'Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException.
', 'StartCrawlerSchedule' => 'Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED.
Starts a recommendation run that is used to generate rules when you don\'t know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.
', 'StartDataQualityRulesetEvaluationRun' => 'Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table). The evaluation computes results which you can retrieve with the GetDataQualityResult API.
Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning workflow. You typically use StartExportLabelsTaskRun when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts the TransformId whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a TaskRunId. You can check on the status of your task run by calling the GetMLTaskRun API.
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the quality of your machine learning transform.
After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called \'labeling\' in the machine learning workflows). In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.
By default, StartMLLabelingSetGenerationTaskRun continually learns from and combines all labels that you upload unless you set Replace to true. If you set Replace to true, StartImportLabelsTaskRun deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality.
You can check on the status of your task run by calling the GetMLTaskRun operation.
Starts a job run using a job definition.
', 'StartMLEvaluationTaskRun' => 'Starts a task to estimate the quality of the transform.
When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.
Returns a unique identifier for the run. You can call GetMLTaskRun to get more information about the stats of the EvaluationTaskRun.
Starts the active learning workflow for your machine learning transform to improve the transform\'s quality by generating label sets and adding labels.
When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.
In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”
After the labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.
Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.
', 'StartWorkflowRun' => 'Starts a new run of the specified workflow.
', 'StopCrawler' => 'If the specified crawler is running, stops the crawl.
', 'StopCrawlerSchedule' => 'Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running.
Stops the session.
', 'StopTrigger' => 'Stops a specified trigger.
', 'StopWorkflowRun' => 'Stops the execution of the specified workflow run.
', 'TagResource' => 'Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource. In Glue, you can tag only certain resources. For information about what resources you can tag, see Amazon Web Services Tags in Glue.
', 'UntagResource' => 'Removes tags from a resource.
', 'UpdateBlueprint' => 'Updates a registered blueprint.
', 'UpdateClassifier' => 'Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).
Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdateTable.
Updates a connection definition in the Data Catalog.
', 'UpdateCrawler' => 'Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.
Updates the schedule of a crawler using a cron expression.
Updates the specified data quality ruleset.
', 'UpdateDatabase' => 'Updates an existing database definition in a Data Catalog.
', 'UpdateDevEndpoint' => 'Updates a specified development endpoint.
', 'UpdateJob' => 'Updates an existing job definition. The previous job definition is completely overwritten by this information.
', 'UpdateJobFromSourceControl' => 'Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.
This API supports optional parameters which take in the repository information.
', 'UpdateMLTransform' => 'Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.
After calling this operation, you can call the StartMLEvaluationTaskRun operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).
Updates a partition.
', 'UpdateRegistry' => 'Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry.
', 'UpdateSchema' => 'Updates the description, compatibility setting, or version checkpoint for a schema set.
For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.
If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema.
This update will happen only if the schema is in the AVAILABLE state.
', 'UpdateSourceControlFromJob' => 'Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job.
This API supports optional parameters which take in the repository information.
', 'UpdateTable' => 'Updates a metadata table in the Data Catalog.
', 'UpdateTrigger' => 'Updates a trigger definition.
', 'UpdateUserDefinedFunction' => 'Updates an existing function definition in the Data Catalog.
', 'UpdateWorkflow' => 'Updates an existing workflow.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'Access to a resource was denied.
', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'LakeFormationConfiguration$AccountId' => 'Required for cross account crawls. For same account crawls as the target data, this can be left as null.
', ], ], 'Action' => [ 'base' => 'Defines an action to be initiated by a trigger.
', 'refs' => [ 'ActionList$member' => NULL, ], ], 'ActionList' => [ 'base' => NULL, 'refs' => [ 'CreateTriggerRequest$Actions' => 'The actions initiated by this trigger when it fires.
', 'Trigger$Actions' => 'The actions initiated by this trigger.
', 'TriggerUpdate$Actions' => 'The actions initiated by this trigger.
', ], ], 'AdditionalOptionKeys' => [ 'base' => NULL, 'refs' => [ 'DQAdditionalOptions$key' => NULL, ], ], 'AdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'CatalogDeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'CatalogHudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'JDBCConnectorTarget$AdditionalOptions' => 'Additional connection options for the connector.
', 'S3CatalogDeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'S3CatalogHudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'S3DeltaCatalogTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3DeltaDirectTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3DeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'S3HudiCatalogTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3HudiDirectTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3HudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'SnowflakeNodeData$AdditionalOptions' => 'Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
', 'SparkConnectorSource$AdditionalOptions' => 'Additional connection options for the connector.
', 'SparkConnectorTarget$AdditionalOptions' => 'Additional connection options for the connector.
', ], ], 'AdditionalPlanOptionsMap' => [ 'base' => NULL, 'refs' => [ 'GetPlanRequest$AdditionalPlanOptionsMap' => 'A map to hold additional optional key-value parameters.
Currently, these key-value pairs are supported:
inferSchema — Specifies whether to set inferSchema to true or false for the default script generated by an Glue job. For example, to set inferSchema to true, pass the following key value pair:
--additional-plan-options-map \'{"inferSchema":"true"}\'
Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
', ], ], 'Aggregate' => [ 'base' => 'Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
', 'refs' => [ 'CodeGenConfigurationNode$Aggregate' => 'Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
', ], ], 'AggregateOperation' => [ 'base' => 'Specifies the set of parameters needed to perform aggregation in the aggregate transform.
', 'refs' => [ 'AggregateOperations$member' => NULL, ], ], 'AggregateOperations' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Aggs' => 'Specifies the aggregate functions to be performed on specified fields.
', ], ], 'AlreadyExistsException' => [ 'base' => 'A resource to be created or added already exists.
', 'refs' => [], ], 'AmazonRedshiftAdvancedOption' => [ 'base' => 'Specifies an optional value when connecting to the Redshift cluster.
', 'refs' => [ 'AmazonRedshiftAdvancedOptions$member' => NULL, ], ], 'AmazonRedshiftAdvancedOptions' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$AdvancedOptions' => 'Optional values when connecting to the Redshift cluster.
', ], ], 'AmazonRedshiftNodeData' => [ 'base' => 'Specifies an Amazon Redshift node.
', 'refs' => [ 'AmazonRedshiftSource$Data' => 'Specifies the data of the Amazon Reshift source node.
', 'AmazonRedshiftTarget$Data' => 'Specifies the data of the Amazon Redshift target node.
', ], ], 'AmazonRedshiftSource' => [ 'base' => 'Specifies an Amazon Redshift source.
', 'refs' => [ 'CodeGenConfigurationNode$AmazonRedshiftSource' => 'Specifies a target that writes to a data source in Amazon Redshift.
', ], ], 'AmazonRedshiftTarget' => [ 'base' => 'Specifies an Amazon Redshift target.
', 'refs' => [ 'CodeGenConfigurationNode$AmazonRedshiftTarget' => 'Specifies a target that writes to a data target in Amazon Redshift.
', ], ], 'ApplyMapping' => [ 'base' => 'Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
', 'refs' => [ 'CodeGenConfigurationNode$ApplyMapping' => 'Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
', ], ], 'AthenaConnectorSource' => [ 'base' => 'Specifies a connector to an Amazon Athena data source.
', 'refs' => [ 'CodeGenConfigurationNode$AthenaConnectorSource' => 'Specifies a connector to an Amazon Athena data source.
', ], ], 'AttemptCount' => [ 'base' => NULL, 'refs' => [ 'JobRun$Attempt' => 'The number of the attempt to run this job.
', ], ], 'AuditColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'AuditContext$RequestedColumns' => 'The requested columns for audit.
', ], ], 'AuditContext' => [ 'base' => 'A structure containing the Lake Formation audit context.
', 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', 'GetUnfilteredPartitionsMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', 'GetUnfilteredTableMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', ], ], 'AuditContextString' => [ 'base' => NULL, 'refs' => [ 'AuditContext$AdditionalAuditContext' => 'A string containing the additional audit context information.
', ], ], 'AuthTokenString' => [ 'base' => NULL, 'refs' => [ 'UpdateJobFromSourceControlRequest$AuthToken' => 'The value of the authorization token.
', 'UpdateSourceControlFromJobRequest$AuthToken' => 'The value of the authorization token.
', ], ], 'BackfillError' => [ 'base' => 'A list of errors that can occur when registering partition indexes for an existing table.
These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:
EncryptedPartitionError: The partitions are encrypted.
InvalidPartitionTypeDataError: The partition value doesn\'t match the data type for that partition column.
MissingPartitionValueError: The partitions are encrypted.
UnsupportedPartitionCharacterError: Characters inside the partition value are not supported. For example: U+0000 , U+0001, U+0002.
InternalError: Any error which does not belong to other error codes.
The error code for an error that occurred when registering partition indexes for an existing table.
', ], ], 'BackfillErroredPartitionsList' => [ 'base' => NULL, 'refs' => [ 'BackfillError$Partitions' => 'A list of a limited number of partitions in the response.
', ], ], 'BackfillErrors' => [ 'base' => NULL, 'refs' => [ 'PartitionIndexDescriptor$BackfillErrors' => 'A list of errors that can occur when registering partition indexes for an existing table.
', ], ], 'BasicCatalogTarget' => [ 'base' => 'Specifies a target that uses a Glue Data Catalog table.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogTarget' => 'Specifies a target that uses a Glue Data Catalog table.
', ], ], 'BatchCreatePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchCreatePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionValueList' => [ 'base' => NULL, 'refs' => [ 'BatchDeletePartitionRequest$PartitionsToDelete' => 'A list of PartitionInput structures that define the partitions to be deleted.
A list of the table to delete.
', ], ], 'BatchDeleteTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTableVersionList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionRequest$VersionIds' => 'A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer. Each version is incremented by 1.
A list of blueprint names.
', ], ], 'BatchGetBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCustomEntityTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCustomEntityTypesResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDataQualityResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDataQualityResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionValueList' => [ 'base' => NULL, 'refs' => [ 'BatchGetPartitionRequest$PartitionsToGet' => 'A list of partition values identifying the partitions to retrieve.
', 'BatchGetPartitionResponse$UnprocessedKeys' => 'A list of the partition values in the request for which partitions were not returned.
', ], ], 'BatchGetTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchSize' => [ 'base' => NULL, 'refs' => [ 'EventBatchingCondition$BatchSize' => 'Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
', ], ], 'BatchStopJobRunError' => [ 'base' => 'Records an error that occurred when attempting to stop a specified job run.
', 'refs' => [ 'BatchStopJobRunErrorList$member' => NULL, ], ], 'BatchStopJobRunErrorList' => [ 'base' => NULL, 'refs' => [ 'BatchStopJobRunResponse$Errors' => 'A list of the errors that were encountered in trying to stop JobRuns, including the JobRunId for which each error was encountered and details about the error.
A list of the JobRunIds that should be stopped for that job definition.
Records a successful request to stop a specified JobRun.
A list of the JobRuns that were successfully submitted for stopping.
', ], ], 'BatchUpdatePartitionFailureEntry' => [ 'base' => 'Contains information about a batch update partition error.
', 'refs' => [ 'BatchUpdatePartitionFailureList$member' => NULL, ], ], 'BatchUpdatePartitionFailureList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePartitionResponse$Errors' => 'The errors encountered when trying to update the requested partitions. A list of BatchUpdatePartitionFailureEntry objects.
A structure that contains the values and structure used to update a partition.
', 'refs' => [ 'BatchUpdatePartitionRequestEntryList$member' => NULL, ], ], 'BatchUpdatePartitionRequestEntryList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePartitionRequest$Entries' => 'A list of up to 100 BatchUpdatePartitionRequestEntry objects to update.
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
', ], ], 'BinaryColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for bit sequence data values.
', 'refs' => [ 'ColumnStatisticsData$BinaryColumnStatisticsData' => 'Binary column statistics data.
', ], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'DecimalNumber$UnscaledValue' => 'The unscaled numeric value.
', ], ], 'Blueprint' => [ 'base' => 'The details of a blueprint.
', 'refs' => [ 'Blueprints$member' => NULL, 'GetBlueprintResponse$Blueprint' => 'Returns a Blueprint object.
The details of a blueprint.
', 'refs' => [ 'Workflow$BlueprintDetails' => 'This structure indicates the details of the blueprint that this particular workflow is created from.
', ], ], 'BlueprintNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetBlueprintsResponse$MissingBlueprints' => 'Returns a list of BlueprintNames that were not found.
List of names of blueprints in the account.
', ], ], 'BlueprintParameterSpec' => [ 'base' => NULL, 'refs' => [ 'Blueprint$ParameterSpec' => 'A JSON string that indicates the list of parameter specifications for the blueprint.
', 'LastActiveDefinition$ParameterSpec' => 'A JSON string specifying the parameters for the blueprint.
', ], ], 'BlueprintParameters' => [ 'base' => NULL, 'refs' => [ 'BlueprintRun$Parameters' => 'The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec.
Specifies the parameters as a BlueprintParameters object.
The details of a blueprint run.
', 'refs' => [ 'BlueprintRuns$member' => NULL, 'GetBlueprintRunResponse$BlueprintRun' => 'Returns a BlueprintRun object.
The state of the blueprint run. Possible values are:
Running — The blueprint run is in progress.
Succeeded — The blueprint run completed successfully.
Failed — The blueprint run failed and rollback is complete.
Rolling Back — The blueprint run failed and rollback is in progress.
Returns a list of BlueprintRun objects.
The status of the blueprint registration.
Creating — The blueprint registration is in progress.
Active — The blueprint has been successfully registered.
Updating — An update to the blueprint registration is in progress.
Failed — The blueprint registration failed.
Returns a list of blueprint as a Blueprints object.
True if the migration has completed, or False otherwise.
True if the value is used as a parameter.
', 'ConnectionPasswordEncryption$ReturnConnectionPasswordEncrypted' => 'When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption.
True if the crawler is still estimating how long it will take to complete this run.
', 'GetConnectionRequest$HidePassword' => 'Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
', 'GetConnectionsRequest$HidePassword' => 'Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
', 'GetUnfilteredPartitionMetadataResponse$IsRegisteredWithLakeFormation' => 'A Boolean value that indicates whether the partition location is registered with Lake Formation.
', 'GetUnfilteredTableMetadataResponse$IsRegisteredWithLakeFormation' => 'A Boolean value that indicates whether the partition location is registered with Lake Formation.
', 'StorageDescriptor$Compressed' => ' True if the data in the table is compressed, or False if not.
True if the table data is stored in subdirectories, or False if not.
Indicates whether the table has been registered with Lake Formation.
', 'UnfilteredPartition$IsRegisteredWithLakeFormation' => 'A Boolean value indicating that the partition location is registered with Lake Formation.
', ], ], 'BooleanColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for Boolean data columns.
', 'refs' => [ 'ColumnStatisticsData$BooleanColumnStatisticsData' => 'Boolean column statistics data.
', ], ], 'BooleanNullable' => [ 'base' => NULL, 'refs' => [ 'GetPartitionsRequest$ExcludeColumnSchema' => 'When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
', 'UpdateTableRequest$SkipArchive' => 'By default, UpdateTable always creates an archived version of the table before updating it. However, if skipArchive is set to true, UpdateTable does not create the archived version.
The action used on Redshift sinks when doing an APPEND.
', 'CreateTriggerRequest$StartOnCreation' => 'Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.
True if a list of predecessor runs should be returned.
', 'S3CsvSource$OptimizePerformance' => 'A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
', 'SnowflakeNodeData$Upsert' => 'Used when Action is append. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.
Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
', 'UpdateDevEndpointRequest$UpdateEtlLibraries' => ' True if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False if otherwise.
A list of values defining the partitions.
', 'BatchUpdatePartitionRequestEntry$PartitionValueList' => 'A list of values defining the partitions.
', 'UpdatePartitionRequest$PartitionValueList' => 'List of partition key values that define the partition to update.
', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'CatalogKafkaSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'CatalogKinesisSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'CatalogSchemaChangePolicy$EnableUpdateCatalog' => 'Whether to use the specified update behavior when the crawler finds a changed schema.
', 'DQResultsPublishingOptions$CloudWatchMetricsEnabled' => 'Enable metrics for your data quality results.
', 'DQResultsPublishingOptions$ResultsPublishingEnabled' => 'Enable publishing for your data quality results.
', 'DirectKafkaSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'DirectKinesisSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'DirectSchemaChangePolicy$EnableUpdateCatalog' => 'Whether to use the specified update behavior when the crawler finds a changed schema.
', 'FilterExpression$Negated' => 'Whether the expression is to be negated.
', 'KafkaStreamingSourceOptions$IncludeHeaders' => 'Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
If true, then the column is removed.
', 'NullCheckBoxList$IsEmpty' => 'Specifies that an empty string is considered as a null value.
', 'NullCheckBoxList$IsNullString' => 'Specifies that a value spelling out the word \'null\' is considered as a null value.
', 'NullCheckBoxList$IsNegOne' => 'Specifies that an integer value of -1 is considered as a null value.
', 'S3CsvSource$Recurse' => 'If set to true, recursively reads files in all subdirectories under the specified paths.
', 'S3CsvSource$Multiline' => 'A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.
A Boolean value that specifies whether to treat the first line as a header. The default value is False.
A Boolean value that specifies whether to write the header to output. The default value is True.
A Boolean value that specifies whether to skip the first data line. The default value is False.
Sets option to enable a sample path.
', 'S3JsonSource$Recurse' => 'If set to true, recursively reads files in all subdirectories under the specified paths.
', 'S3JsonSource$Multiline' => 'A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.
If set to true, recursively reads files in all subdirectories under the specified paths.
', 'TransformConfigParameter$IsOptional' => 'Specifies whether the parameter is optional or not in the config file of the dynamic transform.
', ], ], 'BoxedDoubleFraction' => [ 'base' => NULL, 'refs' => [ 'PIIDetection$SampleFraction' => 'Indicates the fraction of the data to sample when scanning for PII entities.
', 'PIIDetection$ThresholdFraction' => 'Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
', ], ], 'BoxedLong' => [ 'base' => NULL, 'refs' => [ 'S3DirectSourceAdditionalOptions$BoundedSize' => 'Sets the upper limit for the target size of the dataset in bytes that will be processed.
', 'S3DirectSourceAdditionalOptions$BoundedFiles' => 'Sets the upper limit for the target number of files that will be processed.
', 'S3SourceAdditionalOptions$BoundedSize' => 'Sets the upper limit for the target size of the dataset in bytes that will be processed.
', 'S3SourceAdditionalOptions$BoundedFiles' => 'Sets the upper limit for the target number of files that will be processed.
', ], ], 'BoxedNonNegativeInt' => [ 'base' => NULL, 'refs' => [ 'KafkaStreamingSourceOptions$NumRetries' => 'The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
', 'KinesisStreamingSourceOptions$NumRetries' => 'The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3CsvSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', 'S3JsonSource$MaxBand' => 'This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3JsonSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', 'S3ParquetSource$MaxBand' => 'This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3ParquetSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', ], ], 'BoxedNonNegativeLong' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorOptions$LowerBound' => 'The minimum value of partitionColumn that is used to decide partition stride.
The maximum value of partitionColumn that is used to decide partition stride.
The number of partitions. This value, along with lowerBound (inclusive) and upperBound (exclusive), form partition strides for generated WHERE clause expressions that are used to split the partitionColumn.
The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.
The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
The amount of time to spend processing each micro batch.
', 'CatalogKinesisSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', 'DirectKafkaSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', 'DirectKinesisSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', ], ], 'CancelDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelMLTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelMLTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'CatalogDeltaSource' => [ 'base' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogDeltaSource' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
', ], ], 'CatalogEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRest$CatalogEncryptionMode' => 'The encryption-at-rest mode for encrypting Data Catalog data.
', ], ], 'CatalogEntries' => [ 'base' => NULL, 'refs' => [ 'GetMappingRequest$Sinks' => 'A list of target tables.
', 'GetPlanRequest$Sinks' => 'The target tables.
', ], ], 'CatalogEntry' => [ 'base' => 'Specifies a table definition in the Glue Data Catalog.
', 'refs' => [ 'CatalogEntries$member' => NULL, 'GetMappingRequest$Source' => 'Specifies the source table.
', 'GetPlanRequest$Source' => 'The source table.
', ], ], 'CatalogGetterPageSize' => [ 'base' => NULL, 'refs' => [ 'GetDatabasesRequest$MaxResults' => 'The maximum number of databases to return in one response.
', 'GetTableVersionsRequest$MaxResults' => 'The maximum number of table versions to return in one response.
', 'GetTablesRequest$MaxResults' => 'The maximum number of tables to return in a single response.
', 'GetUserDefinedFunctionsRequest$MaxResults' => 'The maximum number of functions to return in one response.
', ], ], 'CatalogHudiSource' => [ 'base' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogHudiSource' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog.
', ], ], 'CatalogIdString' => [ 'base' => NULL, 'refs' => [ 'BatchCreatePartitionRequest$CatalogId' => 'The ID of the catalog in which the partition is to be created. Currently, this should be the Amazon Web Services account ID.
', 'BatchDeleteConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeletePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeleteTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeleteTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchGetPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'BatchUpdatePartitionRequest$CatalogId' => 'The ID of the catalog in which the partition is to be updated. Currently, this should be the Amazon Web Services account ID.
', 'CreateConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services account ID is used by default.
', 'CreateDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services account ID is used by default.
', 'CreatePartitionIndexRequest$CatalogId' => 'The catalog ID where the table resides.
', 'CreatePartitionRequest$CatalogId' => 'The Amazon Web Services account ID of the catalog in which the partition is to be created.
', 'CreateTableRequest$CatalogId' => 'The ID of the Data Catalog in which to create the Table. If none is supplied, the Amazon Web Services account ID is used by default.
The ID of the Data Catalog in which to create the function. If none is provided, the Amazon Web Services account ID is used by default.
', 'Database$CatalogId' => 'The ID of the Data Catalog in which the database resides.
', 'DatabaseIdentifier$CatalogId' => 'The ID of the Data Catalog in which the database resides.
', 'DeleteColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'DeleteColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'DeleteConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeletePartitionIndexRequest$CatalogId' => 'The catalog ID where the table resides.
', 'DeletePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetCatalogImportStatusRequest$CatalogId' => 'The ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.
', 'GetColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetConnectionsRequest$CatalogId' => 'The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDataCatalogEncryptionSettingsRequest$CatalogId' => 'The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDatabasesRequest$CatalogId' => 'The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.
The catalog ID where the table resides.
', 'GetPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetPartitionsRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableVersionsRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTablesRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetUnfilteredPartitionMetadataRequest$CatalogId' => 'The catalog ID where the partition resides.
', 'GetUnfilteredPartitionsMetadataRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default.
', 'GetUnfilteredTableMetadataRequest$CatalogId' => 'The catalog ID where the table resides.
', 'GetUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetUserDefinedFunctionsRequest$CatalogId' => 'The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the Amazon Web Services account ID is used by default.
', 'ImportCatalogToGlueRequest$CatalogId' => 'The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.
', 'Partition$CatalogId' => 'The ID of the Data Catalog in which the partition resides.
', 'PutDataCatalogEncryptionSettingsRequest$CatalogId' => 'The ID of the Data Catalog to set the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
', 'SearchTablesRequest$CatalogId' => 'A unique identifier, consisting of account_id .
The ID of the Data Catalog in which the table resides.
', 'TableIdentifier$CatalogId' => 'The ID of the Data Catalog in which the table resides.
', 'UpdateColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'UpdateColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'UpdateConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdatePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be updated resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be updated is located. If none is provided, the Amazon Web Services account ID is used by default.
', 'UserDefinedFunction$CatalogId' => 'The ID of the Data Catalog in which the function resides.
', ], ], 'CatalogImportStatus' => [ 'base' => 'A structure containing migration status information.
', 'refs' => [ 'GetCatalogImportStatusResponse$ImportStatus' => 'The status of the specified catalog migration.
', ], ], 'CatalogKafkaSource' => [ 'base' => 'Specifies an Apache Kafka data store in the Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogKafkaSource' => 'Specifies an Apache Kafka data store in the Data Catalog.
', ], ], 'CatalogKinesisSource' => [ 'base' => 'Specifies a Kinesis data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogKinesisSource' => 'Specifies a Kinesis data source in the Glue Data Catalog.
', ], ], 'CatalogSchemaChangePolicy' => [ 'base' => 'A policy that specifies update behavior for the crawler.
', 'refs' => [ 'GovernedCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the governed catalog.
', 'S3CatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3DeltaCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3HudiCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', ], ], 'CatalogSource' => [ 'base' => 'Specifies a data store in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogSource' => 'Specifies a data store in the Glue Data Catalog.
', ], ], 'CatalogTablesList' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$Tables' => 'A list of the tables to be synchronized.
', ], ], 'CatalogTarget' => [ 'base' => 'Specifies an Glue Data Catalog target.
', 'refs' => [ 'CatalogTargetList$member' => NULL, ], ], 'CatalogTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$CatalogTargets' => 'Specifies Glue Data Catalog targets.
', ], ], 'CheckSchemaVersionValidityInput' => [ 'base' => NULL, 'refs' => [], ], 'CheckSchemaVersionValidityResponse' => [ 'base' => NULL, 'refs' => [], ], 'Classification' => [ 'base' => NULL, 'refs' => [ 'CreateGrokClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
', 'CreateXMLClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches.
', 'GrokClassifier$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
', 'UpdateGrokClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
', 'UpdateXMLClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches.
', 'XMLClassifier$Classification' => 'An identifier of the data format that the classifier matches.
', ], ], 'Classifier' => [ 'base' => 'Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a StructType object that matches that data format.
You can use the standard classifiers that Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a grok classifier, an XML classifier, a JSON classifier, or a custom CSV classifier, as specified in one of the fields in the Classifier object.
The requested classifier.
', ], ], 'ClassifierList' => [ 'base' => NULL, 'refs' => [ 'GetClassifiersResponse$Classifiers' => 'The requested list of classifier objects.
', ], ], 'ClassifierNameList' => [ 'base' => NULL, 'refs' => [ 'Crawler$Classifiers' => 'A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
', 'CreateCrawlerRequest$Classifiers' => 'A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
', 'UpdateCrawlerRequest$Classifiers' => 'A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
', ], ], 'CloudWatchEncryption' => [ 'base' => 'Specifies how Amazon CloudWatch data should be encrypted.
', 'refs' => [ 'EncryptionConfiguration$CloudWatchEncryption' => 'The encryption configuration for Amazon CloudWatch.
', ], ], 'CloudWatchEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEncryption$CloudWatchEncryptionMode' => 'The encryption mode to use for CloudWatch data.
', ], ], 'CodeGenArgName' => [ 'base' => NULL, 'refs' => [ 'CodeGenEdge$TargetParameter' => 'The target of the edge.
', 'CodeGenNodeArg$Name' => 'The name of the argument or property.
', ], ], 'CodeGenArgValue' => [ 'base' => NULL, 'refs' => [ 'CodeGenNodeArg$Value' => 'The value of the argument or property.
', ], ], 'CodeGenConfigurationNode' => [ 'base' => ' CodeGenConfigurationNode enumerates all valid Node types. One and only one of its member variables can be populated.
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', 'Job$CodeGenConfigurationNodes' => 'The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', 'JobUpdate$CodeGenConfigurationNodes' => 'The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', ], ], 'CodeGenEdge' => [ 'base' => 'Represents a directional edge in a directed acyclic graph (DAG).
', 'refs' => [ 'DagEdges$member' => NULL, ], ], 'CodeGenIdentifier' => [ 'base' => NULL, 'refs' => [ 'CodeGenEdge$Source' => 'The ID of the node at which the edge starts.
', 'CodeGenEdge$Target' => 'The ID of the node at which the edge ends.
', 'CodeGenNode$Id' => 'A node identifier that is unique within the node\'s graph.
', ], ], 'CodeGenNode' => [ 'base' => 'Represents a node in a directed acyclic graph (DAG)
', 'refs' => [ 'DagNodes$member' => NULL, ], ], 'CodeGenNodeArg' => [ 'base' => 'An argument or property of a node.
', 'refs' => [ 'CodeGenNodeArgs$member' => NULL, ], ], 'CodeGenNodeArgs' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$Args' => 'Properties of the node, in the form of name-value pairs.
', 'Location$Jdbc' => 'A JDBC location.
', 'Location$S3' => 'An Amazon Simple Storage Service (Amazon S3) location.
', 'Location$DynamoDB' => 'An Amazon DynamoDB table location.
', ], ], 'CodeGenNodeType' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$NodeType' => 'The type of node that this is.
', ], ], 'Column' => [ 'base' => 'A column in a Table.
Encapsulates a column name that failed and the reason for failure.
', 'refs' => [ 'ColumnErrors$member' => NULL, ], ], 'ColumnErrors' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionResponse$Errors' => 'Error occurred during retrieving column statistics data.
', 'GetColumnStatisticsForTableResponse$Errors' => 'List of ColumnStatistics that failed to be retrieved.
', ], ], 'ColumnImportance' => [ 'base' => 'A structure containing the column name and column importance score for a column.
Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.
', 'refs' => [ 'ColumnImportanceList$member' => NULL, ], ], 'ColumnImportanceList' => [ 'base' => NULL, 'refs' => [ 'FindMatchesMetrics$ColumnImportances' => 'A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.
A list of the Columns in the table.
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
', 'SchemaColumn$Name' => 'The name of the column.
', ], ], 'ColumnRowFilter' => [ 'base' => 'A filter that uses both column-level and row-level filtering.
', 'refs' => [ 'ColumnRowFilterList$member' => NULL, ], ], 'ColumnRowFilterList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredTableMetadataResponse$CellFilters' => 'A list of column row filters.
', ], ], 'ColumnStatistics' => [ 'base' => 'Represents the generated column-level statistics for a table or partition.
', 'refs' => [ 'ColumnStatisticsError$ColumnStatistics' => 'The ColumnStatistics of the column.
Contains the individual types of column statistics data. Only one data object should be set and indicated by the Type attribute.
A ColumnStatisticData object that contains the statistics data values.
Encapsulates a ColumnStatistics object that failed and the reason for failure.
Error occurred during updating column statistics data.
', 'UpdateColumnStatisticsForTableResponse$Errors' => 'List of ColumnStatisticsErrors.
', ], ], 'ColumnStatisticsList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionResponse$ColumnStatisticsList' => 'List of ColumnStatistics that failed to be retrieved.
', 'GetColumnStatisticsForTableResponse$ColumnStatisticsList' => 'List of ColumnStatistics.
', ], ], 'ColumnStatisticsType' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsData$Type' => 'The type of column statistics data.
', ], ], 'ColumnTypeString' => [ 'base' => NULL, 'refs' => [ 'Column$Type' => 'The data type of the Column.
The hive type for this column in the Glue Studio schema.
', 'KeySchemaElement$Type' => 'The type of a partition key.
', 'SchemaColumn$DataType' => 'The type of data in the column.
', ], ], 'ColumnValueStringList' => [ 'base' => NULL, 'refs' => [ 'SkewedInfo$SkewedColumnValues' => 'A list of values that appear so frequently as to be considered skewed.
', ], ], 'ColumnValuesString' => [ 'base' => NULL, 'refs' => [ 'ColumnValueStringList$member' => NULL, 'LocationMap$key' => NULL, 'LocationMap$value' => NULL, ], ], 'CommentString' => [ 'base' => NULL, 'refs' => [ 'Column$Comment' => 'A free-form text comment.
', ], ], 'CommitIdString' => [ 'base' => NULL, 'refs' => [ 'UpdateJobFromSourceControlRequest$CommitId' => 'A commit ID for a commit in the remote repository.
', 'UpdateSourceControlFromJobRequest$CommitId' => 'A commit ID for a commit in the remote repository.
', ], ], 'Comparator' => [ 'base' => NULL, 'refs' => [ 'PropertyPredicate$Comparator' => 'The comparator used to compare this property to others.
', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaInput$Compatibility' => 'The compatibility mode of the schema. The possible values are:
NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can\'t be read by readers using the previous version.
BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
The schema compatibility mode.
', 'GetSchemaResponse$Compatibility' => 'The compatibility mode of the schema.
', 'UpdateSchemaInput$Compatibility' => 'The new compatibility setting for the schema.
', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'S3CsvSource$CompressionType' => '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 how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip").
Two processes are trying to modify a resource simultaneously.
', 'refs' => [], ], 'ConcurrentRunsExceededException' => [ 'base' => 'Too many jobs are being run concurrently.
', 'refs' => [], ], 'Condition' => [ 'base' => 'Defines a condition under which a trigger fires.
', 'refs' => [ 'ConditionList$member' => NULL, ], ], 'ConditionCheckFailureException' => [ 'base' => 'A specified condition was not satisfied.
', 'refs' => [], ], 'ConditionList' => [ 'base' => NULL, 'refs' => [ 'Predicate$Conditions' => 'A list of the conditions that determine when the trigger will fire.
', ], ], 'ConflictException' => [ 'base' => 'The CreatePartitions API was called on a table that has indexes enabled.
The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
', 'refs' => [ 'FindMatchesMetrics$ConfusionMatrix' => 'The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
', ], ], 'Connection' => [ 'base' => 'Defines a connection to a data source.
', 'refs' => [ 'ConnectionList$member' => NULL, 'GetConnectionResponse$Connection' => 'The requested connection definition.
', ], ], 'ConnectionInput' => [ 'base' => 'A structure that is used to specify a connection to create or update.
', 'refs' => [ 'CreateConnectionRequest$ConnectionInput' => 'A ConnectionInput object defining the connection to create.
A ConnectionInput object that redefines the connection in question.
A list of requested connection definitions.
', ], ], 'ConnectionName' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$ConnectionName' => 'The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
The name of the connection to use to connect to the Delta table target.
', 'HudiTarget$ConnectionName' => 'The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
', 'IcebergTarget$ConnectionName' => 'The name of the connection to use to connect to the Iceberg target.
', 'JdbcTarget$ConnectionName' => 'The name of the connection to use to connect to the JDBC target.
', 'MongoDBTarget$ConnectionName' => 'The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
', 'S3Target$ConnectionName' => 'The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
', ], ], 'ConnectionPasswordEncryption' => [ 'base' => 'The data structure used by the Data Catalog to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.
When a CreationConnection request arrives containing a password, the Data Catalog first encrypts the password using your KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.
This encryption requires that you set KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.
', 'refs' => [ 'DataCatalogEncryptionSettings$ConnectionPasswordEncryption' => 'When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.
These key-value pairs define parameters for the connection:
HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME".
PASSWORD - A password, if one is used, for the user name.
ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
JDBC_ENGINE - The name of the JDBC engine to use.
JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
CONFIG_FILES - (Reserved for future use.)
INSTANCE_ID - The instance ID to use.
JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer\'s root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.
CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.
SECRET_ID - The secret ID used for the secret manager of credentials.
CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.
CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.
CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.
KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".
KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".
KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).
KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_MECHANISM - "SCRAM-SHA-512", "GSSAPI", or "AWS_MSK_IAM". These are the supported SASL Mechanisms.
KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.
KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
These key-value pairs define parameters for the connection.
', ], ], 'ConnectionPropertyKey' => [ 'base' => NULL, 'refs' => [ 'ConnectionProperties$key' => NULL, ], ], 'ConnectionType' => [ 'base' => NULL, 'refs' => [ 'Connection$ConnectionType' => 'The type of the connection. Currently, SFTP is not supported.
', 'ConnectionInput$ConnectionType' => 'The type of the connection. Currently, these types are supported:
JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
JDBC Connections use the following ConnectionParameters.
Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.
Required: All of (USERNAME, PASSWORD) or SECRET_ID.
Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
KAFKA - Designates a connection to an Apache Kafka streaming platform.
KAFKA Connections use the following ConnectionParameters.
Required: KAFKA_BOOTSTRAP_SERVERS.
Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.
Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.
Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.
Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.
Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.
MONGODB - Designates a connection to a MongoDB document database.
MONGODB Connections use the following ConnectionParameters.
Required: CONNECTION_URL.
Required: All of (USERNAME, PASSWORD) or SECRET_ID.
NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
MARKETPLACE Connections use the following ConnectionParameters.
Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.
Required for JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.
CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
SFTP is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
', 'GetConnectionsFilter$ConnectionType' => 'The type of connections to return. Currently, SFTP is not supported.
', ], ], 'ConnectionsList' => [ 'base' => 'Specifies the connections used by a job.
', 'refs' => [ 'CreateJobRequest$Connections' => 'The connections used for this job.
', 'CreateSessionRequest$Connections' => 'The number of connections to use for the session.
', 'Job$Connections' => 'The connections used for this job.
', 'JobUpdate$Connections' => 'The connections used for this job.
', 'Session$Connections' => 'The number of connections used for the session.
', ], ], 'ContextWords' => [ 'base' => NULL, 'refs' => [ 'CreateCustomEntityTypeRequest$ContextWords' => 'A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
', 'CustomEntityType$ContextWords' => 'A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
', 'GetCustomEntityTypeResponse$ContextWords' => 'A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
', ], ], 'Crawl' => [ 'base' => 'The details of a crawl in the workflow.
', 'refs' => [ 'CrawlList$member' => NULL, ], ], 'CrawlId' => [ 'base' => NULL, 'refs' => [ 'CrawlerHistory$CrawlId' => 'A UUID identifier for each crawl.
', ], ], 'CrawlList' => [ 'base' => NULL, 'refs' => [ 'CrawlerNodeDetails$Crawls' => 'A list of crawls represented by the crawl node.
', ], ], 'CrawlState' => [ 'base' => NULL, 'refs' => [ 'Condition$CrawlState' => 'The state of the crawler to which this condition applies.
', 'Crawl$State' => 'The state of the crawler.
', ], ], 'Crawler' => [ 'base' => 'Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the Glue Data Catalog.
', 'refs' => [ 'CrawlerList$member' => NULL, 'GetCrawlerResponse$Crawler' => 'The metadata for the specified crawler.
', ], ], 'CrawlerConfiguration' => [ 'base' => NULL, 'refs' => [ 'Crawler$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', 'CreateCrawlerRequest$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', 'UpdateCrawlerRequest$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', ], ], 'CrawlerHistory' => [ 'base' => 'Contains the information for a run of a crawler.
', 'refs' => [ 'CrawlerHistoryList$member' => NULL, ], ], 'CrawlerHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListCrawlsResponse$Crawls' => 'A list of CrawlerHistory objects representing the crawl runs that meet your criteria.
The state of the crawl.
', ], ], 'CrawlerLineageSettings' => [ 'base' => NULL, 'refs' => [ 'LineageConfiguration$CrawlerLineageSettings' => 'Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
A list of crawler definitions.
', 'GetCrawlersResponse$Crawlers' => 'A list of crawler metadata.
', ], ], 'CrawlerMetrics' => [ 'base' => 'Metrics for a specified crawler.
', 'refs' => [ 'CrawlerMetricsList$member' => NULL, ], ], 'CrawlerMetricsList' => [ 'base' => NULL, 'refs' => [ 'GetCrawlerMetricsResponse$CrawlerMetricsList' => 'A list of metrics for the specified crawler.
', ], ], 'CrawlerNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetCrawlersRequest$CrawlerNames' => 'A list of crawler names, which might be the names returned from the ListCrawlers operation.
A list of names of crawlers that were not found.
', 'GetCrawlerMetricsRequest$CrawlerNameList' => 'A list of the names of crawlers about which to retrieve metrics.
', 'ListCrawlersResponse$CrawlerNames' => 'The names of all crawlers in the account, or the crawlers with the specified tags.
', ], ], 'CrawlerNodeDetails' => [ 'base' => 'The details of a Crawler node present in the workflow.
', 'refs' => [ 'Node$CrawlerDetails' => 'Details of the crawler when the node represents a crawler.
', ], ], 'CrawlerNotRunningException' => [ 'base' => 'The specified crawler is not running.
', 'refs' => [], ], 'CrawlerRunningException' => [ 'base' => 'The operation cannot be performed because the crawler is already running.
', 'refs' => [], ], 'CrawlerSecurityConfiguration' => [ 'base' => NULL, 'refs' => [ 'Crawler$CrawlerSecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used by this crawler.
The name of the SecurityConfiguration structure to be used by this crawler.
The name of the SecurityConfiguration structure to be used by this crawler.
Indicates whether the crawler is running, or whether a run is pending.
', ], ], 'CrawlerStoppingException' => [ 'base' => 'The specified crawler is stopping.
', 'refs' => [], ], 'CrawlerTargets' => [ 'base' => 'Specifies data stores to crawl.
', 'refs' => [ 'Crawler$Targets' => 'A collection of targets to crawl.
', 'CreateCrawlerRequest$Targets' => 'A list of collection of targets to crawl.
', 'UpdateCrawlerRequest$Targets' => 'A list of targets to crawl.
', ], ], 'CrawlsFilter' => [ 'base' => 'A list of fields, comparators and value that you can use to filter the crawler runs for a specified crawler.
', 'refs' => [ 'CrawlsFilterList$member' => NULL, ], ], 'CrawlsFilterList' => [ 'base' => NULL, 'refs' => [ 'ListCrawlsRequest$Filters' => 'Filters the crawls by the criteria you specify in a list of CrawlsFilter objects.
Specifies a custom CSV classifier for CreateClassifier to create.
A CsvClassifier object specifying the classifier to create.
Specifies a grok classifier for CreateClassifier to create.
A GrokClassifier object specifying the classifier to create.
Specifies a JSON classifier for CreateClassifier to create.
A JsonClassifier object specifying the classifier to create.
Request to create a new session.
', 'refs' => [], ], 'CreateSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateXMLClassifierRequest' => [ 'base' => 'Specifies an XML classifier for CreateClassifier to create.
An XMLClassifier object specifying the classifier to create.
The date and time the registry was created.
', 'GetSchemaByDefinitionResponse$CreatedTime' => 'The date and time the schema was created.
', 'GetSchemaResponse$CreatedTime' => 'The date and time the schema was created.
', 'GetSchemaVersionResponse$CreatedTime' => 'The date and time the schema version was created.
', 'MetadataInfo$CreatedTime' => 'The time at which the entry was created.
', 'OtherMetadataValueListItem$CreatedTime' => 'The time at which the entry was created.
', 'RegistryListItem$CreatedTime' => 'The data the registry was created.
', 'SchemaListItem$CreatedTime' => 'The date and time that a schema was created.
', 'SchemaVersionListItem$CreatedTime' => 'The date and time the schema version was created.
', ], ], 'CronExpression' => [ 'base' => NULL, 'refs' => [ 'CreateCrawlerRequest$Schedule' => 'A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
The updated cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
A classifier for custom CSV content.
A classifier for comma-separated values (CSV).
', ], ], 'CsvColumnDelimiter' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', 'CsvClassifier$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', 'UpdateCsvClassifierRequest$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', ], ], 'CsvHeader' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Header' => 'A list of strings representing column names.
', 'CsvClassifier$Header' => 'A list of strings representing column names.
', 'UpdateCsvClassifierRequest$Header' => 'A list of strings representing column names.
', ], ], 'CsvHeaderOption' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', 'CsvClassifier$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', 'UpdateCsvClassifierRequest$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', ], ], 'CsvQuoteSymbol' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.
', 'CsvClassifier$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
', 'UpdateCsvClassifierRequest$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
', ], ], 'CustomCode' => [ 'base' => 'Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
', 'refs' => [ 'CodeGenConfigurationNode$CustomCode' => 'Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
', ], ], 'CustomDatatypes' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$CustomDatatypes' => 'Creates a list of supported custom datatypes.
', 'CsvClassifier$CustomDatatypes' => 'A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
', 'UpdateCsvClassifierRequest$CustomDatatypes' => 'Specifies a list of supported custom datatypes.
', ], ], 'CustomEntityType' => [ 'base' => 'An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.
', 'refs' => [ 'CustomEntityTypes$member' => NULL, ], ], 'CustomEntityTypeNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomEntityTypesRequest$Names' => 'A list of names of the custom patterns that you want to retrieve.
', 'BatchGetCustomEntityTypesResponse$CustomEntityTypesNotFound' => 'A list of the names of custom patterns that were not found.
', ], ], 'CustomEntityTypes' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomEntityTypesResponse$CustomEntityTypes' => 'A list of CustomEntityType objects representing the custom patterns that have been created.
A list of CustomEntityType objects representing custom patterns.
Optional custom grok patterns used by this classifier.
', 'GrokClassifier$CustomPatterns' => 'Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.
', 'UpdateGrokClassifierRequest$CustomPatterns' => 'Optional custom grok patterns used by this classifier.
', ], ], 'DQAdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQualityMultiFrame$AdditionalOptions' => 'Options to configure runtime behavior of the transform.
', ], ], 'DQDLAliases' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQualityMultiFrame$AdditionalDataSources' => 'The aliases of all data sources except primary.
', ], ], 'DQDLString' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQuality$Ruleset' => 'The ruleset for your data quality evaluation.
', 'EvaluateDataQualityMultiFrame$Ruleset' => 'The ruleset for your data quality evaluation.
', ], ], 'DQResultsPublishingOptions' => [ 'base' => 'Options to configure how your data quality evaluation results are published.
', 'refs' => [ 'EvaluateDataQuality$PublishingOptions' => 'Options to configure how your results are published.
', 'EvaluateDataQualityMultiFrame$PublishingOptions' => 'Options to configure how your results are published.
', ], ], 'DQStopJobOnFailureOptions' => [ 'base' => 'Options to configure how your job will stop if your data quality evaluation fails.
', 'refs' => [ 'EvaluateDataQuality$StopJobOnFailureOptions' => 'Options to configure how your job will stop if your data quality evaluation fails.
', 'EvaluateDataQualityMultiFrame$StopJobOnFailureOptions' => 'Options to configure how your job will stop if your data quality evaluation fails.
', ], ], 'DQStopJobOnFailureTiming' => [ 'base' => NULL, 'refs' => [ 'DQStopJobOnFailureOptions$StopJobOnFailureTiming' => 'When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
', ], ], 'DQTransformOutput' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQuality$Output' => 'The output of your data quality evaluation.
', ], ], 'DagEdges' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$DagEdges' => 'A list of the edges in the DAG.
', 'GetDataflowGraphResponse$DagEdges' => 'A list of the edges in the resulting DAG.
', ], ], 'DagNodes' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$DagNodes' => 'A list of the nodes in the DAG.
', 'GetDataflowGraphResponse$DagNodes' => 'A list of the nodes in the resulting DAG.
', ], ], 'DataCatalogEncryptionSettings' => [ 'base' => 'Contains configuration information for maintaining Data Catalog security.
', 'refs' => [ 'GetDataCatalogEncryptionSettingsResponse$DataCatalogEncryptionSettings' => 'The requested security configuration.
', 'PutDataCatalogEncryptionSettingsRequest$DataCatalogEncryptionSettings' => 'The security configuration to set.
', ], ], 'DataFormat' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityInput$DataFormat' => 'The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The Lake Formation principal.
', 'refs' => [ 'PrincipalPermissions$Principal' => 'The principal who is granted permissions.
', ], ], 'DataLakePrincipalString' => [ 'base' => NULL, 'refs' => [ 'DataLakePrincipal$DataLakePrincipalIdentifier' => 'An identifier for the Lake Formation principal.
', ], ], 'DataQualityEvaluationRunAdditionalRunOptions' => [ 'base' => 'Additional run options you can specify for an evaluation run.
', 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$AdditionalRunOptions' => 'Additional run options you can specify for an evaluation run.
', 'StartDataQualityRulesetEvaluationRunRequest$AdditionalRunOptions' => 'Additional run options you can specify for an evaluation run.
', ], ], 'DataQualityResult' => [ 'base' => 'Describes a data quality result.
', 'refs' => [ 'DataQualityResultsList$member' => NULL, ], ], 'DataQualityResultDescription' => [ 'base' => 'Describes a data quality result.
', 'refs' => [ 'DataQualityResultDescriptionList$member' => NULL, ], ], 'DataQualityResultDescriptionList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityResultsResponse$Results' => 'A list of DataQualityResultDescription objects.
Criteria used to return data quality results.
', 'refs' => [ 'ListDataQualityResultsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityResultIdList' => [ 'base' => NULL, 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$ResultIds' => 'A list of result IDs for the data quality results for the run.
', ], ], 'DataQualityResultIds' => [ 'base' => NULL, 'refs' => [ 'BatchGetDataQualityResultRequest$ResultIds' => 'A list of unique result IDs for the data quality results.
', 'BatchGetDataQualityResultResponse$ResultsNotFound' => 'A list of result IDs for which results were not found.
', ], ], 'DataQualityResultsList' => [ 'base' => NULL, 'refs' => [ 'BatchGetDataQualityResultResponse$Results' => 'A list of DataQualityResult objects representing the data quality results.
Describes the result of a data quality rule recommendation run.
', 'refs' => [ 'DataQualityRuleRecommendationRunList$member' => NULL, ], ], 'DataQualityRuleRecommendationRunFilter' => [ 'base' => 'A filter for listing data quality recommendation runs.
', 'refs' => [ 'ListDataQualityRuleRecommendationRunsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRuleRecommendationRunList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRuleRecommendationRunsResponse$Runs' => 'A list of DataQualityRuleRecommendationRunDescription objects.
Describes the result of the evaluation of a data quality rule.
', 'refs' => [ 'DataQualityRuleResults$member' => NULL, ], ], 'DataQualityRuleResultStatus' => [ 'base' => NULL, 'refs' => [ 'DataQualityRuleResult$Result' => 'A pass or fail status for the rule.
', ], ], 'DataQualityRuleResults' => [ 'base' => NULL, 'refs' => [ 'DataQualityResult$RuleResults' => 'A list of DataQualityRuleResult objects representing the results for each rule.
A list of DataQualityRuleResult objects representing the results for each rule.
Describes the result of a data quality ruleset evaluation run.
', 'refs' => [ 'DataQualityRulesetEvaluationRunList$member' => NULL, ], ], 'DataQualityRulesetEvaluationRunFilter' => [ 'base' => 'The filter criteria.
', 'refs' => [ 'ListDataQualityRulesetEvaluationRunsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRulesetEvaluationRunList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRulesetEvaluationRunsResponse$Runs' => 'A list of DataQualityRulesetEvaluationRunDescription objects representing data quality ruleset runs.
The criteria used to filter data quality rulesets.
', 'refs' => [ 'ListDataQualityRulesetsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRulesetList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRulesetsResponse$Rulesets' => 'A paginated list of rulesets for the specified list of Glue tables.
', ], ], 'DataQualityRulesetListDetails' => [ 'base' => 'Describes a data quality ruleset returned by GetDataQualityRuleset.
A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'GetDataQualityRuleRecommendationRunResponse$RecommendedRuleset' => 'When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.
', 'GetDataQualityRulesetResponse$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'UpdateDataQualityRulesetRequest$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'UpdateDataQualityRulesetResponse$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', ], ], 'DataQualityTargetTable' => [ 'base' => 'An object representing an Glue table.
', 'refs' => [ 'CreateDataQualityRulesetRequest$TargetTable' => 'A target table associated with the data quality ruleset.
', 'DataQualityRulesetFilterCriteria$TargetTable' => 'The name and database name of the target table.
', 'DataQualityRulesetListDetails$TargetTable' => 'An object representing an Glue table.
', 'GetDataQualityRulesetResponse$TargetTable' => 'The name and database name of the target table.
', ], ], 'DataSource' => [ 'base' => 'A data source (an Glue table) for which you want data quality results.
', 'refs' => [ 'DataQualityResult$DataSource' => 'The table associated with the data quality result, if any.
', 'DataQualityResultDescription$DataSource' => 'The table name associated with the data quality result.
', 'DataQualityResultFilterCriteria$DataSource' => 'Filter results by the specified data source. For example, retrieving all results for an Glue table.
', 'DataQualityRuleRecommendationRunDescription$DataSource' => 'The data source (Glue table) associated with the recommendation run.
', 'DataQualityRuleRecommendationRunFilter$DataSource' => 'Filter based on a specified data source (Glue table).
', 'DataQualityRulesetEvaluationRunDescription$DataSource' => 'The data source (an Glue table) associated with the run.
', 'DataQualityRulesetEvaluationRunFilter$DataSource' => 'Filter based on a data source (an Glue table) associated with the run.
', 'DataSourceMap$value' => NULL, 'GetDataQualityResultResponse$DataSource' => 'The table associated with the data quality result, if any.
', 'GetDataQualityRuleRecommendationRunResponse$DataSource' => 'The data source (an Glue table) associated with this run.
', 'GetDataQualityRulesetEvaluationRunResponse$DataSource' => 'The data source (an Glue table) associated with this evaluation run.
', 'StartDataQualityRuleRecommendationRunRequest$DataSource' => 'The data source (Glue table) associated with this run.
', 'StartDataQualityRulesetEvaluationRunRequest$DataSource' => 'The data source (Glue table) associated with this run.
', ], ], 'DataSourceMap' => [ 'base' => NULL, 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$AdditionalDataSources' => 'A map of reference strings to additional data sources you can specify for an evaluation run.
', 'StartDataQualityRulesetEvaluationRunRequest$AdditionalDataSources' => 'A map of reference strings to additional data sources you can specify for an evaluation run.
', ], ], 'Database' => [ 'base' => 'The Database object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.
The definition of the specified database in the Data Catalog.
', ], ], 'DatabaseIdentifier' => [ 'base' => 'A structure that describes a target database for resource linking.
', 'refs' => [ 'Database$TargetDatabase' => 'A DatabaseIdentifier structure that describes a target database for resource linking.
A DatabaseIdentifier structure that describes a target database for resource linking.
The structure used to create or update a database.
', 'refs' => [ 'CreateDatabaseRequest$DatabaseInput' => 'The metadata for the database.
', 'UpdateDatabaseRequest$DatabaseInput' => 'A DatabaseInput object specifying the new definition of the metadata database in the catalog.
A list of Database objects from the specified catalog.
The name of the database in which the crawler\'s output is stored.
', 'CreateCrawlerRequest$DatabaseName' => 'The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.
A structure representing the datatype of the value.
', 'refs' => [ 'NullValueField$Datatype' => 'The datatype of the value.
', ], ], 'DateColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for timestamp data columns.
', 'refs' => [ 'ColumnStatisticsData$DateColumnStatisticsData' => 'Date column statistics data.
', ], ], 'DecimalColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for fixed-point number data columns.
', 'refs' => [ 'ColumnStatisticsData$DecimalColumnStatisticsData' => 'Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two\'s complement representations of the decimal\'s unscaled value.
', ], ], 'DecimalNumber' => [ 'base' => 'Contains a numeric value in decimal format.
', 'refs' => [ 'DecimalColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DecimalColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'DeleteBehavior' => [ 'base' => NULL, 'refs' => [ 'SchemaChangePolicy$DeleteBehavior' => 'The deletion behavior when the crawler finds a deleted object.
', ], ], 'DeleteBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionNameList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionRequest$ConnectionNameList' => 'A list of names of the connections to delete.
', ], ], 'DeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomEntityTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomEntityTypeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityRulesetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityRulesetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatabaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDevEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDevEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMLTransformRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMLTransformResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistryInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeltaTarget' => [ 'base' => 'Specifies a Delta data store to crawl one or more Delta tables.
', 'refs' => [ 'DeltaTargetList$member' => NULL, ], ], 'DeltaTargetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3DeltaDirectTarget$Compression' => '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 Delta data store targets.
', ], ], 'DescriptionString' => [ 'base' => NULL, 'refs' => [ 'Connection$Description' => 'The description of the connection.
', 'ConnectionInput$Description' => 'The description of the connection.
', 'Crawl$ErrorMessage' => 'The error message associated with the crawl.
', 'Crawler$Description' => 'A description of the crawler.
', 'CrawlerHistory$ErrorMessage' => 'If an error occurred, the error message associated with the crawl.
', 'CreateCrawlerRequest$Description' => 'A description of the new crawler.
', 'CreateDataQualityRulesetRequest$Description' => 'A description of the data quality ruleset.
', 'CreateJobRequest$Description' => 'Description of the job being defined.
', 'CreateMLTransformRequest$Description' => 'A description of the machine learning transform that is being defined. The default is an empty string.
', 'CreateRegistryInput$Description' => 'A description of the registry. If description is not provided, there will not be any default value for this.
', 'CreateRegistryResponse$Description' => 'A description of the registry.
', 'CreateSchemaInput$Description' => 'An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
', 'CreateSchemaResponse$Description' => 'A description of the schema if specified when created.
', 'CreateSessionRequest$Description' => 'The description of the session.
', 'CreateTriggerRequest$Description' => 'A description of the new trigger.
', 'DataQualityRuleResult$Description' => 'A description of the data quality rule.
', 'DataQualityRuleResult$EvaluationMessage' => 'An evaluation message.
', 'DataQualityRulesetFilterCriteria$Description' => 'The description of the ruleset filter criteria.
', 'DataQualityRulesetListDetails$Description' => 'A description of the data quality ruleset.
', 'Database$Description' => 'A description of the database.
', 'DatabaseInput$Description' => 'A description of the database.
', 'ErrorDetail$ErrorMessage' => 'A message describing the error.
', 'GetDataQualityRulesetResponse$Description' => 'A description of the ruleset.
', 'GetMLTransformResponse$Description' => 'A description of the transform.
', 'GetRegistryResponse$Description' => 'A description of the registry.
', 'GetSchemaResponse$Description' => 'A description of schema if specified when created
', 'GlueTableAdditionalOptions$value' => NULL, 'Job$Description' => 'A description of the job.
', 'JobUpdate$Description' => 'Description of the job being defined.
', 'LastCrawlInfo$ErrorMessage' => 'If an error occurred, the error information about the last crawl.
', 'MLTransform$Description' => 'A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
', 'RegistryListItem$Description' => 'A description of the registry.
', 'SchemaListItem$Description' => 'A description for the schema.
', 'Session$ErrorMessage' => 'The error message displayed during the session.
', 'Session$Description' => 'The description of the session.
', 'Table$Description' => 'A description of the table.
', 'TableInput$Description' => 'A description of the table.
', 'Trigger$Description' => 'A description of this trigger.
', 'TriggerUpdate$Description' => 'A description of this trigger.
', 'UpdateDataQualityRulesetRequest$Description' => 'A description of the ruleset.
', 'UpdateDataQualityRulesetResponse$Description' => 'A description of the ruleset.
', 'UpdateMLTransformRequest$Description' => 'A description of the transform. The default is an empty string.
', 'UpdateRegistryInput$Description' => 'A description of the registry. If description is not provided, this field will not be updated.
', 'UpdateSchemaInput$Description' => 'The new description for the schema.
', ], ], 'DescriptionStringRemovable' => [ 'base' => NULL, 'refs' => [ 'UpdateCrawlerRequest$Description' => 'A description of the new crawler.
', ], ], 'DevEndpoint' => [ 'base' => 'A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.
', 'refs' => [ 'DevEndpointList$member' => NULL, 'GetDevEndpointResponse$DevEndpoint' => 'A DevEndpoint definition.
Custom libraries to be loaded into a development endpoint.
', 'refs' => [ 'UpdateDevEndpointRequest$CustomLibraries' => 'Custom Python or Java libraries to be loaded in the DevEndpoint.
A list of DevEndpoint definitions.
A list of DevEndpoint definitions.
The names of all the DevEndpoints in the account, or the DevEndpoints with the specified tags.
The list of DevEndpoint names, which might be the names returned from the ListDevEndpoint operation.
A list of DevEndpoints not found.
Specifies the direct JDBC source connection.
', 'refs' => [ 'CodeGenConfigurationNode$DirectJDBCSource' => NULL, ], ], 'DirectKafkaSource' => [ 'base' => 'Specifies an Apache Kafka data store.
', 'refs' => [ 'CodeGenConfigurationNode$DirectKafkaSource' => 'Specifies an Apache Kafka data store.
', ], ], 'DirectKinesisSource' => [ 'base' => 'Specifies a direct Amazon Kinesis data source.
', 'refs' => [ 'CodeGenConfigurationNode$DirectKinesisSource' => 'Specifies a direct Amazon Kinesis data source.
', ], ], 'DirectSchemaChangePolicy' => [ 'base' => 'A policy that specifies update behavior for the crawler.
', 'refs' => [ 'S3DeltaDirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3DirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3GlueParquetTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3HudiDirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'DoubleColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DoubleColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'DoubleColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for floating-point number data columns.
', 'refs' => [ 'ColumnStatisticsData$DoubleColumnStatisticsData' => 'Double column statistics data.
', ], ], 'DoubleValue' => [ 'base' => NULL, 'refs' => [ 'Session$Progress' => 'The code execution progress of the session.
', 'Statement$Progress' => 'The code execution progress.
', ], ], 'DropDuplicates' => [ 'base' => 'Specifies a transform that removes rows of repeating data from a data set.
', 'refs' => [ 'CodeGenConfigurationNode$DropDuplicates' => 'Specifies a transform that removes rows of repeating data from a data set.
', ], ], 'DropFields' => [ 'base' => 'Specifies a transform that chooses the data property keys that you want to drop.
', 'refs' => [ 'CodeGenConfigurationNode$DropFields' => 'Specifies a transform that chooses the data property keys that you want to drop.
', ], ], 'DropNullFields' => [ 'base' => 'Specifies a transform that removes columns from the dataset if all values in the column are \'null\'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
', 'refs' => [ 'CodeGenConfigurationNode$DropNullFields' => 'Specifies a transform that removes columns from the dataset if all values in the column are \'null\'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
', ], ], 'DynamicTransform' => [ 'base' => 'Specifies the set of parameters needed to perform the dynamic transform.
', 'refs' => [ 'CodeGenConfigurationNode$DynamicTransform' => 'Specifies a custom visual transform created by a user.
', ], ], 'DynamoDBCatalogSource' => [ 'base' => 'Specifies a DynamoDB data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$DynamoDBCatalogSource' => 'Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
', ], ], 'DynamoDBTarget' => [ 'base' => 'Specifies an Amazon DynamoDB table to crawl.
', 'refs' => [ 'DynamoDBTargetList$member' => NULL, ], ], 'DynamoDBTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$DynamoDBTargets' => 'Specifies Amazon DynamoDB targets.
', ], ], 'Edge' => [ 'base' => 'An edge represents a directed connection between two Glue components that are part of the workflow the edge belongs to.
', 'refs' => [ 'EdgeList$member' => NULL, ], ], 'EdgeList' => [ 'base' => NULL, 'refs' => [ 'WorkflowGraph$Edges' => 'A list of all the directed connections between the nodes belonging to the workflow.
', ], ], 'EnableAdditionalMetadata' => [ 'base' => NULL, 'refs' => [ 'JdbcTarget$EnableAdditionalMetadata' => 'Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
', ], ], 'EnableHybridValues' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$EnableHybrid' => 'If \'TRUE\', indicates that you are using both methods to grant cross-account access to Data Catalog resources:
By directly updating the resource policy with PutResourePolicy
By using the Grant permissions command on the Amazon Web Services Management Console.
Must be set to \'TRUE\' if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is \'FALSE\'.
Specifies the column on the data set on which the aggregation function will be applied.
', 'FilterValue$Value' => 'The value to be associated.
', 'GlueStudioPathList$member' => NULL, 'JDBCConnectorOptions$JobBookmarkKeys' => 'The name of the job bookmark keys on which to sort.
', 'Mapping$FromPath' => 'The table or column to be modified.
', 'PIIDetection$EntityTypesToDetect' => 'Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
', 'RenameField$SourcePath' => 'A JSON path to a variable in the data structure for the source data.
', 'RenameField$TargetPath' => 'A JSON path to a variable in the data structure for the target data.
', 'S3CsvSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3CsvSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'S3DeltaSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3HudiSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3JsonSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3JsonSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'S3ParquetSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3ParquetSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'TransformConfigParameter$Value' => 'Specifies the value of the parameter in the config file of the dynamic transform.
', ], ], 'EnclosedInStringPropertiesMinOne' => [ 'base' => NULL, 'refs' => [ 'UpsertRedshiftTargetOptions$UpsertKeys' => 'The keys used to determine whether to perform an update or insert.
', ], ], 'EnclosedInStringProperty' => [ 'base' => NULL, 'refs' => [ 'AdditionalOptions$key' => NULL, 'AdditionalOptions$value' => NULL, 'AmazonRedshiftNodeData$TempDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'AthenaConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'AthenaConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'AthenaConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
', 'AthenaConnectorSource$SchemaName' => 'The name of the Cloudwatch log group to read from. For example, /aws-glue/jobs/output.
The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
', 'BasicCatalogTarget$Table' => 'The table that defines the schema of your output data. This table must already exist in the Data Catalog.
', 'CatalogDeltaSource$Database' => 'The name of the database to read from.
', 'CatalogDeltaSource$Table' => 'The name of the table in the database to read from.
', 'CatalogHudiSource$Database' => 'The name of the database to read from.
', 'CatalogHudiSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKafkaSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKafkaSource$Database' => 'The name of the database to read from.
', 'CatalogKinesisSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKinesisSource$Database' => 'The name of the database to read from.
', 'CatalogSource$Database' => 'The name of the database to read from.
', 'CatalogSource$Table' => 'The name of the table in the database to read from.
', 'CustomCode$ClassName' => 'The name defined for the custom code node class.
', 'DQDLAliases$value' => NULL, 'DQResultsPublishingOptions$ResultsS3Prefix' => 'The Amazon S3 prefix prepended to the results.
', 'DirectJDBCSource$Database' => 'The database of the JDBC source connection.
', 'DirectJDBCSource$Table' => 'The table of the JDBC source connection.
', 'DirectJDBCSource$ConnectionName' => 'The connection name of the JDBC source.
', 'DirectJDBCSource$RedshiftTmpDir' => 'The temp directory of the JDBC Redshift source.
', 'DirectSchemaChangePolicy$Table' => 'Specifies the table in the database that the schema change policy applies to.
', 'DirectSchemaChangePolicy$Database' => 'Specifies the database that the schema change policy applies to.
', 'DynamicTransform$Name' => 'Specifies the name of the dynamic transform.
', 'DynamicTransform$TransformName' => 'Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
', 'DynamicTransform$FunctionName' => 'Specifies the name of the function of the dynamic transform.
', 'DynamicTransform$Path' => 'Specifies the path of the dynamic transform source and config files.
', 'DynamicTransform$Version' => 'This field is not used and will be deprecated in future release.
', 'DynamoDBCatalogSource$Database' => 'The name of the database to read from.
', 'DynamoDBCatalogSource$Table' => 'The name of the table in the database to read from.
', 'EnclosedInStringProperties$member' => NULL, 'EnclosedInStringPropertiesMinOne$member' => NULL, 'FillMissingValues$ImputedPath' => 'A JSON path to a variable in the data structure for the dataset that is imputed.
', 'FillMissingValues$FilledPath' => 'A JSON path to a variable in the data structure for the dataset that is filled.
', 'GovernedCatalogSource$Database' => 'The database to read from.
', 'GovernedCatalogSource$Table' => 'The database table to read from.
', 'GovernedCatalogSource$PartitionPredicate' => 'Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to "" – empty by default.
The name of the table in the database to write to.
', 'GovernedCatalogTarget$Database' => 'The name of the database to write to.
', 'JDBCConnectorOptions$FilterPredicate' => 'Extra condition clause to filter data from source. For example:
BillingCity=\'Mountain View\'
When using a query instead of a table name, you should validate that the query works with the specified filterPredicate.
The name of an integer column that is used for partitioning. This option works only when it\'s included with lowerBound, upperBound, and numPartitions. This option works the same way as in the Spark SQL JDBC reader.
Specifies an ascending or descending sort order.
', 'JDBCConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'JDBCConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'JDBCConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
', 'JDBCConnectorTarget$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'JDBCConnectorTarget$ConnectorName' => 'The name of a connector that will be used.
', 'JDBCConnectorTarget$ConnectionType' => 'The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
', 'JoinColumn$From' => 'The column to be joined.
', 'KafkaStreamingSourceOptions$BootstrapServers' => 'A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".
The name of the connection.
', 'KafkaStreamingSourceOptions$TopicName' => 'The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".
The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".
A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".
An optional classification.
', 'KafkaStreamingSourceOptions$Delimiter' => 'Specifies the delimiter character.
', 'KafkaStreamingSourceOptions$StartingOffsets' => 'The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".
The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.
When this option is set to \'true\', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KafkaStreamingSourceOptions$EmitConsumerLagMetrics' => 'When this option is set to \'true\', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric\'s name is "glue.driver.streaming.maxConsumerLagInMs". The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KinesisStreamingSourceOptions$EndpointUrl' => 'The URL of the Kinesis endpoint.
', 'KinesisStreamingSourceOptions$StreamName' => 'The name of the Kinesis data stream.
', 'KinesisStreamingSourceOptions$Classification' => 'An optional classification.
', 'KinesisStreamingSourceOptions$Delimiter' => 'Specifies the delimiter character.
', 'KinesisStreamingSourceOptions$StreamArn' => 'The Amazon Resource Name (ARN) of the Kinesis data stream.
', 'KinesisStreamingSourceOptions$RoleArn' => 'The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN".
When this option is set to \'true\', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KinesisStreamingSourceOptions$EmitConsumerLagMetrics' => 'When this option is set to \'true\', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric\'s name is "glue.driver.streaming.maxConsumerLagInMs". The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'Mapping$ToKey' => 'After the apply mapping, what the name of the column should be. Can be the same as FromPath.
The type of the data to be modified.
', 'Mapping$ToType' => 'The data type that the data is to be modified to.
', 'MicrosoftSQLServerCatalogSource$Database' => 'The name of the database to read from.
', 'MicrosoftSQLServerCatalogSource$Table' => 'The name of the table in the database to read from.
', 'MicrosoftSQLServerCatalogTarget$Database' => 'The name of the database to write to.
', 'MicrosoftSQLServerCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'MySQLCatalogSource$Database' => 'The name of the database to read from.
', 'MySQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'MySQLCatalogTarget$Database' => 'The name of the database to write to.
', 'MySQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'NullValueField$Value' => 'The value of the null placeholder.
', 'Option$Value' => 'Specifies the value of the option.
', 'Option$Label' => 'Specifies the label of the option.
', 'Option$Description' => 'Specifies the description of the option.
', 'OracleSQLCatalogSource$Database' => 'The name of the database to read from.
', 'OracleSQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'OracleSQLCatalogTarget$Database' => 'The name of the database to write to.
', 'OracleSQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'PIIDetection$OutputColumnName' => 'Indicates the output column name that will contain any entity type detected in that row.
', 'PostgreSQLCatalogSource$Database' => 'The name of the database to read from.
', 'PostgreSQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'PostgreSQLCatalogTarget$Database' => 'The name of the database to write to.
', 'PostgreSQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'RecipeReference$RecipeArn' => 'The ARN of the DataBrew recipe.
', 'RedshiftSource$Database' => 'The database to read from.
', 'RedshiftSource$Table' => 'The database table to read from.
', 'RedshiftSource$RedshiftTmpDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'RedshiftSource$TmpDirIAMRole' => 'The IAM role with permissions.
', 'RedshiftTarget$Database' => 'The name of the database to write to.
', 'RedshiftTarget$Table' => 'The name of the table in the database to write to.
', 'RedshiftTarget$RedshiftTmpDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'RedshiftTarget$TmpDirIAMRole' => 'The IAM role with permissions.
', 'RelationalCatalogSource$Database' => 'The name of the database to read from.
', 'RelationalCatalogSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogDeltaSource$Database' => 'The name of the database to read from.
', 'S3CatalogDeltaSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogHudiSource$Database' => 'The name of the database to read from.
', 'S3CatalogHudiSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogSource$Database' => 'The database to read from.
', 'S3CatalogSource$Table' => 'The database table to read from.
', 'S3CatalogSource$PartitionPredicate' => 'Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to "" – empty by default.
The name of the table in the database to write to.
', 'S3CatalogTarget$Database' => 'The name of the database to write to.
', 'S3CsvSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".
The name of the table in the database to write to.
', 'S3DeltaCatalogTarget$Database' => 'The name of the database to write to.
', 'S3DeltaDirectTarget$Path' => 'The Amazon S3 path of your Delta Lake data source to write to.
', 'S3DirectSourceAdditionalOptions$SamplePath' => 'If enabled, specifies the sample path.
', 'S3DirectTarget$Path' => 'A single Amazon S3 path to write to.
', 'S3DirectTarget$Compression' => '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").
A single Amazon S3 path to write to.
', 'S3HudiCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'S3HudiCatalogTarget$Database' => 'The name of the database to write to.
', 'S3HudiDirectTarget$Path' => 'The Amazon S3 path of your Hudi data source to write to.
', 'S3JsonSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".
A JsonPath string defining the JSON data.
', 'S3ParquetSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".
Not currently used.
', 'SparkConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'SparkConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'SparkConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
', 'SparkConnectorTarget$ConnectionName' => 'The name of a connection for an Apache Spark connector.
', 'SparkConnectorTarget$ConnectorName' => 'The name of an Apache Spark connector.
', 'SparkConnectorTarget$ConnectionType' => 'The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
', 'Spigot$Path' => 'A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
', 'TransformConfigParameter$Name' => 'Specifies the name of the parameter in the config file of the dynamic transform.
', 'TransformConfigParameter$ValidationRule' => 'Specifies the validation rule in the config file of the dynamic transform.
', 'TransformConfigParameter$ValidationMessage' => 'Specifies the validation message in the config file of the dynamic transform.
', 'UpsertRedshiftTargetOptions$TableLocation' => 'The physical location of the Redshift table.
', 'UpsertRedshiftTargetOptions$ConnectionName' => 'The name of the connection to use to write to Redshift.
', ], ], 'EnclosedInStringPropertyWithQuote' => [ 'base' => NULL, 'refs' => [ 'AthenaConnectorSource$ConnectionTable' => 'The name of the table in the data source.
', 'JDBCConnectorSource$ConnectionTable' => 'The name of the table in the data source.
', 'JDBCConnectorTarget$ConnectionTable' => 'The name of the table in the data target.
', 'S3CsvSource$Escaper' => 'Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\\n, \\r, \\t, and \\0).
A temporary name given to a table, or a column in a table.
', ], ], 'EncryptionAtRest' => [ 'base' => 'Specifies the encryption-at-rest configuration for the Data Catalog.
', 'refs' => [ 'DataCatalogEncryptionSettings$EncryptionAtRest' => 'Specifies the encryption-at-rest configuration for the Data Catalog.
', ], ], 'EncryptionConfiguration' => [ 'base' => 'Specifies an encryption configuration.
', 'refs' => [ 'CreateSecurityConfigurationRequest$EncryptionConfiguration' => 'The encryption configuration for the new security configuration.
', 'SecurityConfiguration$EncryptionConfiguration' => 'The encryption configuration associated with this security configuration.
', ], ], 'EntityNotFoundException' => [ 'base' => 'A specified entity does not exist
', 'refs' => [], ], 'ErrorByName' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionResponse$Errors' => 'A map of the names of connections that were not successfully deleted to error details.
', ], ], 'ErrorCodeString' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorCode' => 'The error code for an error.
', ], ], 'ErrorDetail' => [ 'base' => 'Contains details about an error.
', 'refs' => [ 'BatchStopJobRunError$ErrorDetail' => 'Specifies details about the error that was encountered.
', 'BatchUpdatePartitionFailureEntry$ErrorDetail' => 'The details about the batch update partition error.
', 'ColumnError$Error' => 'An error message with the reason for the failure of an operation.
', 'ColumnStatisticsError$Error' => 'An error message with the reason for the failure of an operation.
', 'ErrorByName$value' => NULL, 'PartitionError$ErrorDetail' => 'The details about the partition error.
', 'TableError$ErrorDetail' => 'The details about the error.
', 'TableVersionError$ErrorDetail' => 'The details about the error.
', ], ], 'ErrorDetails' => [ 'base' => 'An object containing error details.
', 'refs' => [ 'SchemaVersionErrorItem$ErrorDetails' => 'The details of the error for the schema version.
', ], ], 'ErrorMessageString' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorMessage' => 'The error message for an error.
', ], ], 'ErrorString' => [ 'base' => NULL, 'refs' => [ 'Blueprint$ErrorMessage' => 'An error message.
', 'JobRun$ErrorMessage' => 'An error message associated with this job run.
', 'WorkflowRun$ErrorMessage' => 'This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."
Specifies your data quality evaluation criteria.
', 'refs' => [ 'CodeGenConfigurationNode$EvaluateDataQuality' => 'Specifies your data quality evaluation criteria.
', ], ], 'EvaluateDataQualityMultiFrame' => [ 'base' => 'Specifies your data quality evaluation criteria.
', 'refs' => [ 'CodeGenConfigurationNode$EvaluateDataQualityMultiFrame' => 'Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.
', ], ], 'EvaluatedMetricsMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityRuleResult$EvaluatedMetrics' => 'A map of metrics associated with the evaluation of the rule.
', ], ], 'EvaluationMetrics' => [ 'base' => 'Evaluation metrics provide an estimate of the quality of your machine learning transform.
', 'refs' => [ 'GetMLTransformResponse$EvaluationMetrics' => 'The latest evaluation metrics.
', 'MLTransform$EvaluationMetrics' => 'An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'refs' => [ 'CreateTriggerRequest$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'Trigger$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'TriggerUpdate$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', ], ], 'EventQueueArn' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$EventQueueArn' => 'A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
An execution property of a job.
', 'refs' => [ 'CreateJobRequest$ExecutionProperty' => 'An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
The amount of time (in seconds) that the run consumed resources.
', 'GetDataQualityRulesetEvaluationRunResponse$ExecutionTime' => 'The amount of time (in seconds) that the run consumed resources.
', 'GetMLTaskRunResponse$ExecutionTime' => 'The amount of time (in seconds) that the task run consumed resources.
', 'JobRun$ExecutionTime' => 'The amount of time (in seconds) that the job run consumed resources.
', 'TaskRun$ExecutionTime' => 'The amount of time (in seconds) that the task run consumed resources.
', ], ], 'ExistCondition' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$PolicyExistsCondition' => 'A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call does not depend on the existence of a policy.
Specifies configuration properties for an exporting labels task run.
', 'refs' => [ 'TaskRunProperties$ExportLabelsTaskRunProperties' => 'The configuration properties for an exporting labels task run.
', ], ], 'ExtendedString' => [ 'base' => NULL, 'refs' => [ 'CustomCode$Code' => 'The custom code that is used to perform the data transformation.
', ], ], 'FederatedDatabase' => [ 'base' => 'A database that points to an entity outside the Glue Data Catalog.
', 'refs' => [ 'Database$FederatedDatabase' => 'A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
A federated resource already exists.
', 'refs' => [], ], 'FederatedTable' => [ 'base' => 'A table that points to an entity outside the Glue Data Catalog.
', 'refs' => [ 'Table$FederatedTable' => 'A FederatedTable structure that references an entity outside the Glue Data Catalog.
A unique identifier for the federated database.
', 'FederatedTable$Identifier' => 'A unique identifier for the federated table.
', 'FederatedTable$DatabaseIdentifier' => 'A unique identifier for the federated database.
', ], ], 'FederationSourceErrorCode' => [ 'base' => NULL, 'refs' => [ 'FederationSourceException$FederationSourceErrorCode' => 'The error code of the problem.
', ], ], 'FederationSourceException' => [ 'base' => 'A federation source failed.
', 'refs' => [], ], 'FederationSourceRetryableException' => [ 'base' => NULL, 'refs' => [], ], 'FieldName' => [ 'base' => NULL, 'refs' => [ 'CrawlsFilter$FieldName' => 'A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:
CRAWL_ID: A string representing the UUID identifier for a crawl.
STATE: A string representing the state of the crawl.
START_TIME and END_TIME: The epoch timestamp in milliseconds.
DPU_HOUR: The number of data processing unit (DPU) hours used for the crawl.
The source type.
', 'MappingEntry$TargetType' => 'The target type.
', ], ], 'FillMissingValues' => [ 'base' => 'Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
', 'refs' => [ 'CodeGenConfigurationNode$FillMissingValues' => 'Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
', ], ], 'Filter' => [ 'base' => 'Specifies a transform that splits a dataset into two, based on a filter condition.
', 'refs' => [ 'CodeGenConfigurationNode$Filter' => 'Specifies a transform that splits a dataset into two, based on a filter condition.
', ], ], 'FilterExpression' => [ 'base' => 'Specifies a filter expression.
', 'refs' => [ 'FilterExpressions$member' => NULL, ], ], 'FilterExpressions' => [ 'base' => NULL, 'refs' => [ 'Filter$Filters' => 'Specifies a filter expression.
', ], ], 'FilterLogicalOperator' => [ 'base' => NULL, 'refs' => [ 'Filter$LogicalOperator' => 'The operator used to filter rows by comparing the key value to a specified value.
', ], ], 'FilterOperation' => [ 'base' => NULL, 'refs' => [ 'FilterExpression$Operation' => 'The type of operation to perform in the expression.
', ], ], 'FilterOperator' => [ 'base' => NULL, 'refs' => [ 'CrawlsFilter$FilterOperator' => 'A defined comparator that operates on the value. The available operators are:
GT: Greater than.
GE: Greater than or equal to.
LT: Less than.
LE: Less than or equal to.
EQ: Equal to.
NE: Not equal to.
A regular expression pattern. If present, only those tables whose names match the pattern are returned.
', ], ], 'FilterValue' => [ 'base' => 'Represents a single entry in the list of values for a FilterExpression.
The type of filter value.
', ], ], 'FilterValues' => [ 'base' => NULL, 'refs' => [ 'FilterExpression$Values' => 'A list of filter values.
', ], ], 'FindMatchesMetrics' => [ 'base' => 'The evaluation metrics for the find matches algorithm. The quality of your machine learning transform is measured by getting your transform to predict some matches and comparing the results to known matches from the same dataset. The quality metrics are based on a subset of your data, so they are not precise.
', 'refs' => [ 'EvaluationMetrics$FindMatchesMetrics' => 'The evaluation metrics for the find matches algorithm.
', ], ], 'FindMatchesParameters' => [ 'base' => 'The parameters to configure the find matches transform.
', 'refs' => [ 'TransformParameters$FindMatchesParameters' => 'The parameters for the find matches algorithm.
', ], ], 'FindMatchesTaskRunProperties' => [ 'base' => 'Specifies configuration properties for a Find Matches task run.
', 'refs' => [ 'TaskRunProperties$FindMatchesTaskRunProperties' => 'The configuration properties for a find matches task run.
', ], ], 'FormatString' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$InputFormat' => 'The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
The description of the blueprint.
', 'CreateBlueprintRequest$Description' => 'A description of the blueprint.
', 'LastActiveDefinition$Description' => 'The description of the blueprint.
', 'SourceControlDetails$Repository' => 'The name of the remote repository that contains the job artifacts.
', 'SourceControlDetails$Owner' => 'The owner of the remote repository that contains the job artifacts.
', 'SourceControlDetails$Branch' => 'An optional branch in the remote repository.
', 'SourceControlDetails$Folder' => 'An optional folder in the remote repository.
', 'SourceControlDetails$LastCommitId' => 'The last commit ID for a commit in the remote repository.
', 'SourceControlDetails$AuthToken' => 'The value of an authorization token.
', 'UpdateBlueprintRequest$Description' => 'A description of the blueprint.
', ], ], 'GenericBoundedDouble' => [ 'base' => NULL, 'refs' => [ 'ColumnImportance$Importance' => 'The column importance score for the column, as a decimal.
', 'DataQualityResult$Score' => 'An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
', 'FindMatchesMetrics$AreaUnderPRCurve' => 'The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$Precision' => 'The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$Recall' => 'The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$F1' => 'The maximum F1 metric indicates the transform\'s accuracy between 0 and 1, where 1 is the best accuracy.
For more information, see F1 score in Wikipedia.
', 'FindMatchesParameters$PrecisionRecallTradeoff' => 'The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
', 'FindMatchesParameters$AccuracyCostTradeoff' => 'The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
', 'GetDataQualityResultResponse$Score' => 'An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
', ], ], 'GenericLimitedString' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$AccessType' => 'The access type for the Redshift connection. Can be a direct connection or catalog connections.
', 'AmazonRedshiftNodeData$SourceType' => 'The source type to specify whether a specific table is the source or a custom query.
', 'AmazonRedshiftNodeData$TablePrefix' => 'Specifies the prefix to a table.
', 'AmazonRedshiftNodeData$MergeAction' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled.
', 'AmazonRedshiftNodeData$MergeWhenMatched' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
', 'AmazonRedshiftNodeData$MergeWhenNotMatched' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn\'t match a new record.
', 'DQResultsPublishingOptions$EvaluationContext' => 'The context of the evaluation.
', 'Datatype$Id' => 'The datatype of the value.
', 'Datatype$Label' => 'A label assigned to the datatype.
', 'LimitedStringList$member' => NULL, 'SnowflakeNodeData$SourceType' => 'Specifies how retrieved data is specified. Valid values: "table", "query".
Specifies a merge action. Valid values: simple, custom. If simple, merge behavior is defined by MergeWhenMatched and MergeWhenNotMatched. If custom, defined by MergeClause.
Specifies how to resolve records that match preexisting data when merging. Valid values: update, delete.
Specifies how to process records that do not match preexisting data when merging. Valid values: insert, none.
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
', 'CreateJobRequest$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'CreateJobRequest$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'Job$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'Job$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'JobRun$Arguments' => 'The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'JobUpdate$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'JobUpdate$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'StartJobRunRequest$Arguments' => 'The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', ], ], 'GenericString' => [ 'base' => NULL, 'refs' => [ 'AdditionalPlanOptionsMap$key' => NULL, 'AdditionalPlanOptionsMap$value' => NULL, 'AmazonRedshiftAdvancedOption$Key' => 'The key for the additional connection option.
', 'AmazonRedshiftAdvancedOption$Value' => 'The value for the additional connection option.
', 'AmazonRedshiftNodeData$CatalogRedshiftSchema' => 'The Redshift schema name when working with a data catalog.
', 'AmazonRedshiftNodeData$CatalogRedshiftTable' => 'The database table to read from.
', 'AmazonRedshiftNodeData$SampleQuery' => 'The SQL used to fetch the data from a Redshift sources when the SourceType is \'query\'.
', 'AmazonRedshiftNodeData$PreAction' => 'The SQL used before a MERGE or APPEND with upsert is run.
', 'AmazonRedshiftNodeData$PostAction' => 'The SQL used before a MERGE or APPEND with upsert is run.
', 'AmazonRedshiftNodeData$Action' => 'Specifies how writing to a Redshift cluser will occur.
', 'AmazonRedshiftNodeData$MergeClause' => 'The SQL used in a custom merge to deal with matching records.
', 'AmazonRedshiftNodeData$CrawlerConnection' => 'Specifies the name of the connection that is associated with the catalog table used.
', 'AmazonRedshiftNodeData$StagingTable' => 'The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
', 'Blueprint$BlueprintLocation' => 'Specifies the path in Amazon S3 where the blueprint is published.
', 'Blueprint$BlueprintServiceLocation' => 'Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.
The value provided for comparison on the crawl field.
', 'CreateDevEndpointRequest$EndpointName' => 'The name to be assigned to the new DevEndpoint.
The subnet ID for the new DevEndpoint to use.
The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
The name assigned to the new DevEndpoint.
The current status of the new DevEndpoint.
The subnet ID assigned to the new DevEndpoint.
The address of the YARN endpoint used by this DevEndpoint.
The Amazon Web Services Availability Zone where this DevEndpoint is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint.
The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint.
Path to one or more Java .jar files in an S3 bucket that will be loaded in your DevEndpoint.
The reason for a current failure in this DevEndpoint.
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
This field is required when the trigger type is SCHEDULED.
', 'CreateWorkflowRequest$Description' => 'A description of the workflow.
', 'DQAdditionalOptions$value' => NULL, 'DataQualityResult$EvaluationContext' => 'In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.
The name of the DevEndpoint.
The name of the DevEndpoint.
The subnet ID for this DevEndpoint.
The YARN endpoint address used by this DevEndpoint.
A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.
The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint.
The current status of this DevEndpoint.
The Amazon Web Services Availability Zone where this DevEndpoint is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint.
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
You can only use pure Java/Scala libraries with a DevEndpoint.
The reason for a current failure in this DevEndpoint.
The status of the last update.
', 'DevEndpoint$PublicKey' => 'The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3) bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
You can only use pure Java/Scala libraries with a DevEndpoint.
A continuation token, if this is a continuation request.
', 'GetBlueprintRunsResponse$NextToken' => 'A continuation token, if not all blueprint runs have been returned.
', 'GetDataQualityResultResponse$EvaluationContext' => 'In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.
The error strings that are associated with the run.
', 'GetDataQualityRulesetEvaluationRunResponse$ErrorString' => 'The error strings that are associated with the run.
', 'GetDevEndpointRequest$EndpointName' => 'Name of the DevEndpoint to retrieve information for.
A continuation token, if this is a continuation call.
', 'GetDevEndpointsResponse$NextToken' => 'A continuation token, if not all DevEndpoint definitions have yet been returned.
A continuation token, if this is a continuation call.
', 'GetJobRunsResponse$NextToken' => 'A continuation token, if not all requested job runs have been returned.
', 'GetJobsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetJobsResponse$NextToken' => 'A continuation token, if not all job definitions have yet been returned.
', 'GetMLTaskRunResponse$LogGroupName' => 'The names of the log groups that are associated with the task run.
', 'GetMLTaskRunResponse$ErrorString' => 'The error strings that are associated with the task run.
', 'GetSecurityConfigurationsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetSecurityConfigurationsResponse$NextToken' => 'A continuation token, if there are more security configurations to return.
', 'GetTriggersRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetTriggersResponse$NextToken' => 'A continuation token, if not all the requested triggers have yet been returned.
', 'GetWorkflowRunsRequest$NextToken' => 'The maximum size of the response.
', 'GetWorkflowRunsResponse$NextToken' => 'A continuation token, if not all requested workflow runs have been returned.
', 'JobCommand$Name' => 'The name of the job command. For an Apache Spark ETL job, this must be glueetl. For a Python shell job, it must be pythonshell. For an Apache Spark streaming ETL job, this must be gluestreaming. For a Ray job, this must be glueray.
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration is used to encrypt the log group.
Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.
', 'LastActiveDefinition$BlueprintServiceLocation' => 'Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.
', 'ListBlueprintsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListBlueprintsResponse$NextToken' => 'A continuation token, if not all blueprint names have been returned.
', 'ListDevEndpointsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListDevEndpointsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListJobsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListJobsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListTriggersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListTriggersResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListWorkflowsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListWorkflowsResponse$NextToken' => 'A continuation token, if not all workflow names have been returned.
', 'MapValue$key' => NULL, 'MapValue$value' => NULL, 'OrchestrationStringList$member' => NULL, 'PublicKeysList$member' => NULL, 'SnowflakeNodeData$Schema' => 'Specifies a Snowflake database schema for your node to use.
', 'SnowflakeNodeData$Table' => 'Specifies a Snowflake table for your node to use.
', 'SnowflakeNodeData$Database' => 'Specifies a Snowflake database for your node to use.
', 'SnowflakeNodeData$SampleQuery' => 'A SQL string used to retrieve data with the query sourcetype.
A SQL string run before the Snowflake connector performs its standard actions.
', 'SnowflakeNodeData$PostAction' => 'A SQL string run after the Snowflake connector performs its standard actions.
', 'SnowflakeNodeData$Action' => 'Specifies what action to take when writing to a table with preexisting data. Valid values: append, merge, truncate, drop.
A SQL statement that specifies a custom merge behavior.
', 'SnowflakeNodeData$StagingTable' => 'The name of a staging table used when performing merge or upsert append actions. Data is written to this table, then moved to table by a generated postaction.
The execution code of the statement.
', 'StatementOutput$ErrorName' => 'The name of the error in the output.
', 'StatementOutput$ErrorValue' => 'The error value of the output.
', 'StatementOutputData$TextPlain' => 'The code execution output in text format.
', 'StringList$member' => NULL, 'TaskRun$LogGroupName' => 'The names of the log group for secure logging, associated with this task run.
', 'TaskRun$ErrorString' => 'The list of error strings associated with this task run.
', 'Trigger$Schedule' => 'A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
The name of the DevEndpoint to be updated.
The public key for the DevEndpoint to use.
The description of the workflow.
', 'Workflow$Description' => 'A description of the workflow.
', 'WorkflowRunProperties$value' => NULL, ], ], 'GetBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCatalogImportStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCatalogImportStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifiersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifiersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionRequest$ColumnNames' => 'A list of the column names.
', 'GetColumnStatisticsForTableRequest$ColumnNames' => 'A list of the column names.
', ], ], 'GetColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsFilter' => [ 'base' => 'Filters the connection definitions that are returned by the GetConnections API operation.
A filter that controls which connections are returned.
', ], ], 'GetConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomEntityTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomEntityTypeResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataCatalogEncryptionSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataCatalogEncryptionSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataflowGraphRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataflowGraphResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobBookmarkRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobBookmarkResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMappingResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionIndexesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionIndexesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRegistryInput' => [ 'base' => NULL, 'refs' => [], ], 'GetRegistryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesResponseList' => [ 'base' => NULL, 'refs' => [ 'GetResourcePoliciesResponse$GetResourcePoliciesResponseList' => 'A list of the individual resource policies and the account-level resource policy.
', ], ], 'GetResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaByDefinitionInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaByDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionsDiffInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionsDiffResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetTableVersionsResponse$TableVersions' => 'A list of strings identifying available versions of the specified table.
', ], ], 'GetTableVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTablesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTablesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionsMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionsMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredTableMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredTableMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GlueEncryptionException' => [ 'base' => 'An encryption operation failed.
', 'refs' => [], ], 'GluePolicy' => [ 'base' => 'A structure for returning a resource policy.
', 'refs' => [ 'GetResourcePoliciesResponseList$member' => NULL, ], ], 'GlueRecordType' => [ 'base' => NULL, 'refs' => [ 'JDBCDataTypeMapping$value' => NULL, ], ], 'GlueResourceArn' => [ 'base' => NULL, 'refs' => [ 'CreateRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the newly created registry.
', 'CreateSchemaResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'CreateSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'DeleteRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry being deleted.
', 'DeleteResourcePolicyRequest$ResourceArn' => 'The ARN of the Glue resource for the resource policy to be deleted.
', 'DeleteSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema being deleted.
', 'FederatedResourceAlreadyExistsException$AssociatedGlueResource' => 'The associated Glue resource already exists.
', 'GetRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'GetResourcePolicyRequest$ResourceArn' => 'The ARN of the Glue resource for which to retrieve the resource policy. If not supplied, the Data Catalog resource policy is returned. Use GetResourcePolicies to view all existing resource policies. For more information see Specifying Glue Resource ARNs.
The Amazon Resource Name (ARN) of the schema.
', 'GetSchemaResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'GetSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'GetSchemaVersionResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'GetTagsRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
', 'PutResourcePolicyRequest$ResourceArn' => 'Do not use. For internal use only.
', 'PutSchemaVersionMetadataResponse$SchemaArn' => 'The Amazon Resource Name (ARN) for the schema.
', 'RegistryId$RegistryArn' => 'Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.
The Amazon Resource Name (ARN) of the registry.
', 'RemoveSchemaVersionMetadataResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'SchemaId$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The Amazon Resource Name (ARN) for the schema.
', 'SchemaVersionListItem$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'TagResourceRequest$ResourceArn' => 'The ARN of the Glue resource to which to add the tags. For more information about Glue resource ARNs, see the Glue ARN string pattern.
', 'UntagResourceRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource from which to remove the tags.
', 'UpdateRegistryResponse$RegistryArn' => 'The Amazon Resource name (ARN) of the updated registry.
', 'UpdateSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', ], ], 'GlueSchema' => [ 'base' => 'Specifies a user-defined schema when a schema cannot be determined by Glue.
', 'refs' => [ 'GlueSchemas$member' => NULL, ], ], 'GlueSchemas' => [ 'base' => NULL, 'refs' => [ 'AthenaConnectorSource$OutputSchemas' => 'Specifies the data schema for the custom Athena source.
', 'CatalogDeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'CatalogHudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'CustomCode$OutputSchemas' => 'Specifies the data schema for the custom code transform.
', 'DynamicTransform$OutputSchemas' => 'Specifies the data schema for the dynamic transform.
', 'JDBCConnectorSource$OutputSchemas' => 'Specifies the data schema for the custom JDBC source.
', 'JDBCConnectorTarget$OutputSchemas' => 'Specifies the data schema for the JDBC target.
', 'S3CatalogDeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'S3CatalogHudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'S3CsvSource$OutputSchemas' => 'Specifies the data schema for the S3 CSV source.
', 'S3DeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'S3HudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'S3JsonSource$OutputSchemas' => 'Specifies the data schema for the S3 JSON source.
', 'S3ParquetSource$OutputSchemas' => 'Specifies the data schema for the S3 Parquet source.
', 'SnowflakeSource$OutputSchemas' => 'Specifies user-defined schemas for your output data.
', 'SparkConnectorSource$OutputSchemas' => 'Specifies data schema for the custom spark source.
', 'SparkConnectorTarget$OutputSchemas' => 'Specifies the data schema for the custom spark target.
', 'SparkSQL$OutputSchemas' => 'Specifies the data schema for the SparkSQL transform.
', ], ], 'GlueStudioColumnNameString' => [ 'base' => NULL, 'refs' => [ 'GlueStudioSchemaColumn$Name' => 'The name of the column in the Glue Studio schema.
', ], ], 'GlueStudioPathList' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Groups' => 'Specifies the fields to group by.
', 'DropFields$Paths' => 'A JSON path to a variable in the data structure.
', 'GovernedCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'JoinColumn$Keys' => 'The key of the column to be joined.
', 'Merge$PrimaryKeys' => 'The list of primary key fields to match records from the source and staging dynamic frames.
', 'S3CatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DeltaCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DeltaDirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3GlueParquetTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3HudiCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3HudiDirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'SelectFields$Paths' => 'A JSON path to a variable in the data structure.
', 'SplitFields$Paths' => 'A JSON path to a variable in the data structure.
', ], ], 'GlueStudioSchemaColumn' => [ 'base' => 'Specifies a single column in a Glue schema definition.
', 'refs' => [ 'GlueStudioSchemaColumnList$member' => NULL, ], ], 'GlueStudioSchemaColumnList' => [ 'base' => NULL, 'refs' => [ 'GlueSchema$Columns' => 'Specifies the column definitions that make up a Glue schema.
', ], ], 'GlueTable' => [ 'base' => 'The database and table in the Glue Data Catalog that is used for input or output data.
', 'refs' => [ 'DataSource$GlueTable' => 'An Glue table.
', 'GlueTables$member' => NULL, ], ], 'GlueTableAdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'GlueTable$AdditionalOptions' => 'Additional options for the table. Currently there are two keys supported:
pushDownPredicate: to filter on partitions without having to list and read all the files in your dataset.
catalogPartitionPredicate: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
A list of Glue table definitions used by the transform.
', 'GetMLTransformResponse$InputRecordTables' => 'A list of Glue table definitions used by the transform.
', 'MLTransform$InputRecordTables' => 'A list of Glue table definitions used by the transform.
', ], ], 'GlueVersionString' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$GlueVersion' => 'Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
', 'CreateJobRequest$GlueVersion' => 'In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'CreateMLTransformRequest$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'CreateSessionRequest$GlueVersion' => 'The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
', 'DevEndpoint$GlueVersion' => 'Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'Job$GlueVersion' => 'In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'JobRun$GlueVersion' => 'In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'JobUpdate$GlueVersion' => 'In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'MLTransform$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'Session$GlueVersion' => 'The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
', 'TransformFilterCriteria$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'UpdateMLTransformRequest$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', ], ], 'GovernedCatalogSource' => [ 'base' => 'Specifies the data store in the governed Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$GovernedCatalogSource' => 'Specifies a data source in a goverened Data Catalog.
', ], ], 'GovernedCatalogTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$GovernedCatalogTarget' => 'Specifies a data target that writes to a goverened catalog.
', ], ], 'GrokClassifier' => [ 'base' => 'A classifier that uses grok patterns.
A classifier that uses grok.
The grok pattern used by this classifier.
', 'GrokClassifier$GrokPattern' => 'The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.
', 'UpdateGrokClassifierRequest$GrokPattern' => 'The grok pattern used by this classifier.
', ], ], 'HashString' => [ 'base' => NULL, 'refs' => [ 'CancelDataQualityRuleRecommendationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'CancelDataQualityRulesetEvaluationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'CancelMLTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'CancelMLTaskRunRequest$TaskRunId' => 'A unique identifier for the task run.
', 'CancelMLTaskRunResponse$TransformId' => 'The unique identifier of the machine learning transform.
', 'CancelMLTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'CreateDataQualityRulesetRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'CreateMLTransformResponse$TransformId' => 'A unique identifier that is generated for the transform.
', 'DataQualityResult$ResultId' => 'A unique result ID for the data quality result.
', 'DataQualityResult$JobRunId' => 'The job run ID associated with the data quality result, if any.
', 'DataQualityResult$RulesetEvaluationRunId' => 'The unique run ID for the ruleset evaluation for this data quality result.
', 'DataQualityResultDescription$ResultId' => 'The unique result ID for this data quality result.
', 'DataQualityResultDescription$JobRunId' => 'The job run ID associated with the data quality result.
', 'DataQualityResultFilterCriteria$JobRunId' => 'Filter results by the specified job run ID.
', 'DataQualityResultIdList$member' => NULL, 'DataQualityResultIds$member' => NULL, 'DataQualityRuleRecommendationRunDescription$RunId' => 'The unique run identifier associated with this run.
', 'DataQualityRulesetEvaluationRunDescription$RunId' => 'The unique run identifier associated with this run.
', 'DataQualityRulesetListDetails$RecommendationRunId' => 'When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
', 'DeleteMLTransformRequest$TransformId' => 'The unique identifier of the transform to delete.
', 'DeleteMLTransformResponse$TransformId' => 'The unique identifier of the transform that was deleted.
', 'DeleteResourcePolicyRequest$PolicyHashCondition' => 'The hash value returned when this policy was set.
', 'FindMatchesTaskRunProperties$JobId' => 'The job ID for the Find Matches task run.
', 'FindMatchesTaskRunProperties$JobRunId' => 'The job run ID for the Find Matches task run.
', 'GetDataQualityResultRequest$ResultId' => 'A unique result ID for the data quality result.
', 'GetDataQualityResultResponse$ResultId' => 'A unique result ID for the data quality result.
', 'GetDataQualityResultResponse$JobRunId' => 'The job run ID associated with the data quality result, if any.
', 'GetDataQualityResultResponse$RulesetEvaluationRunId' => 'The unique run ID associated with the ruleset evaluation.
', 'GetDataQualityRuleRecommendationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRuleRecommendationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetEvaluationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetEvaluationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetResponse$RecommendationRunId' => 'When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
', 'GetMLTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'GetMLTaskRunRequest$TaskRunId' => 'The unique identifier of the task run.
', 'GetMLTaskRunResponse$TransformId' => 'The unique identifier of the task run.
', 'GetMLTaskRunResponse$TaskRunId' => 'The unique run identifier associated with this run.
', 'GetMLTaskRunsRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'GetMLTransformRequest$TransformId' => 'The unique identifier of the transform, generated at the time that the transform was created.
', 'GetMLTransformResponse$TransformId' => 'The unique identifier of the transform, generated at the time that the transform was created.
', 'GetResourcePolicyResponse$PolicyHash' => 'Contains the hash value associated with this policy.
', 'GluePolicy$PolicyHash' => 'Contains the hash value associated with this policy.
', 'MLTransform$TransformId' => 'The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
', 'PutResourcePolicyRequest$PolicyHashCondition' => 'The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.
A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.
', 'StartDataQualityRuleRecommendationRunRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'StartDataQualityRuleRecommendationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'StartDataQualityRulesetEvaluationRunRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'StartDataQualityRulesetEvaluationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'StartExportLabelsTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartExportLabelsTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'StartImportLabelsTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartImportLabelsTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'StartMLEvaluationTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartMLEvaluationTaskRunResponse$TaskRunId' => 'The unique identifier associated with this run.
', 'StartMLLabelingSetGenerationTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartMLLabelingSetGenerationTaskRunResponse$TaskRunId' => 'The unique run identifier that is associated with this task run.
', 'TaskRun$TransformId' => 'The unique identifier for the transform.
', 'TaskRun$TaskRunId' => 'The unique identifier for this task run.
', 'TransformIdList$member' => NULL, 'UpdateMLTransformRequest$TransformId' => 'A unique identifier that was generated when the transform was created.
', 'UpdateMLTransformResponse$TransformId' => 'The unique identifier for the transform that was updated.
', ], ], 'HudiTarget' => [ 'base' => 'Specifies an Apache Hudi data source.
', 'refs' => [ 'HudiTargetList$member' => NULL, ], ], 'HudiTargetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3HudiDirectTarget$Compression' => '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 Apache Hudi data store targets.
', ], ], 'IcebergInput' => [ 'base' => 'A structure that defines an Apache Iceberg metadata table to create in the catalog.
', 'refs' => [ 'OpenTableFormatInput$IcebergInput' => 'Specifies an IcebergInput structure that defines an Apache Iceberg metadata table.
Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
', 'refs' => [ 'IcebergTargetList$member' => NULL, ], ], 'IcebergTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$IcebergTargets' => 'Specifies Apache Iceberg data store targets.
', ], ], 'IdString' => [ 'base' => NULL, 'refs' => [ 'BatchStopJobRunError$JobRunId' => 'The JobRunId of the job run in question.
The JobRunId of the job run that was stopped.
The run ID for this blueprint.
', 'BlueprintRun$RunId' => 'The run ID for this blueprint run.
', 'GetBlueprintRunRequest$RunId' => 'The run ID for the blueprint run you want to retrieve.
', 'GetJobRunRequest$RunId' => 'The ID of the job run.
', 'GetWorkflowRunPropertiesRequest$RunId' => 'The ID of the workflow run whose run properties should be returned.
', 'GetWorkflowRunRequest$RunId' => 'The ID of the workflow run.
', 'JobRun$Id' => 'The ID of this job run.
', 'JobRun$PreviousRunId' => 'The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
The job-run ID of the predecessor job run.
', 'PutWorkflowRunPropertiesRequest$RunId' => 'The ID of the workflow run for which the run properties should be updated.
', 'ResumeWorkflowRunRequest$RunId' => 'The ID of the workflow run to resume.
', 'ResumeWorkflowRunResponse$RunId' => 'The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
', 'StartBlueprintRunResponse$RunId' => 'The run ID for this blueprint run.
', 'StartJobRunRequest$JobRunId' => 'The ID of a previous JobRun to retry.
The ID assigned to this job run.
', 'StartWorkflowRunResponse$RunId' => 'An Id for the new run.
', 'StopWorkflowRunRequest$RunId' => 'The ID of the workflow run to stop.
', 'Trigger$Id' => 'Reserved for future use.
', 'WorkflowRun$WorkflowRunId' => 'The ID of this workflow run.
', 'WorkflowRun$PreviousRunId' => 'The ID of the previous workflow run.
', 'WorkflowRunProperties$key' => NULL, ], ], 'IdempotentParameterMismatchException' => [ 'base' => 'The same unique identifier was associated with two different records.
', 'refs' => [], ], 'IllegalBlueprintStateException' => [ 'base' => 'The blueprint is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'IllegalSessionStateException' => [ 'base' => 'The session is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'IllegalWorkflowStateException' => [ 'base' => 'The workflow is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'ImportCatalogToGlueRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportCatalogToGlueResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportLabelsTaskRunProperties' => [ 'base' => 'Specifies configuration properties for an importing labels task run.
', 'refs' => [ 'TaskRunProperties$ImportLabelsTaskRunProperties' => 'The configuration properties for an importing labels task run.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$LineNumber' => 'The line number of the node.
', 'DecimalNumber$Scale' => 'The scale that determines where the decimal point falls in the unscaled value.
', 'StorageDescriptor$NumberOfBuckets' => 'Must be specified if the table contains any dimension columns.
', ], ], 'IntegerFlag' => [ 'base' => NULL, 'refs' => [ 'Order$SortOrder' => 'Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).
The ID of the statement to be cancelled.
', 'CreateDevEndpointRequest$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) to allocate to this DevEndpoint.
The Apache Zeppelin port for the remote Apache Spark interpreter.
', 'CreateDevEndpointResponse$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
', 'CreateJobRequest$AllocatedCapacity' => 'This parameter is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'DevEndpoint$ZeppelinRemoteSparkInterpreterPort' => 'The Apache Zeppelin port for the remote Apache Spark interpreter.
', 'DevEndpoint$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
The Id of the statement.
', 'Job$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'JobBookmarkEntry$Version' => 'The version of the job.
', 'JobBookmarkEntry$Run' => 'The run ID number.
', 'JobBookmarkEntry$Attempt' => 'The attempt ID number.
', 'JobRun$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'JobUpdate$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'RunStatementResponse$Id' => 'Returns the Id of the statement that was run.
', 'StartJobRunRequest$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'Statement$Id' => 'The ID of the statement.
', 'StatementOutput$ExecutionCount' => 'The execution count of the output.
', 'WorkflowRunStatistics$TotalActions' => 'Total number of Actions in the workflow run.
', 'WorkflowRunStatistics$TimeoutActions' => 'Total number of Actions that timed out.
', 'WorkflowRunStatistics$FailedActions' => 'Total number of Actions that have failed.
', 'WorkflowRunStatistics$StoppedActions' => 'Total number of Actions that have stopped.
', 'WorkflowRunStatistics$SucceededActions' => 'Total number of Actions that have succeeded.
', 'WorkflowRunStatistics$RunningActions' => 'Total number Actions in running state.
', 'WorkflowRunStatistics$ErroredActions' => 'Indicates the count of job runs in the ERROR state in the workflow run.
', 'WorkflowRunStatistics$WaitingActions' => 'Indicates the count of job runs in WAITING state in the workflow run.
', ], ], 'InternalServiceException' => [ 'base' => 'An internal service error occurred.
', 'refs' => [], ], 'InvalidInputException' => [ 'base' => 'The input provided was not valid.
', 'refs' => [], ], 'InvalidStateException' => [ 'base' => 'An error that indicates your data is in an invalid state.
', 'refs' => [], ], 'IsVersionValid' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityResponse$Valid' => 'Return true, if the schema is valid and false otherwise.
', ], ], 'Iso8601DateTime' => [ 'base' => NULL, 'refs' => [ 'KafkaStreamingSourceOptions$StartingTimestamp' => 'The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
Only one of StartingTimestamp or StartingOffsets must be set.
The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
The connection type of the JDBC source.
', ], ], 'JDBCConnectorOptions' => [ 'base' => 'Additional connection options for the connector.
', 'refs' => [ 'JDBCConnectorSource$AdditionalOptions' => 'Additional connection options for the connector.
', ], ], 'JDBCConnectorSource' => [ 'base' => 'Specifies a connector to a JDBC data source.
', 'refs' => [ 'CodeGenConfigurationNode$JDBCConnectorSource' => 'Specifies a connector to a JDBC data source.
', ], ], 'JDBCConnectorTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', 'refs' => [ 'CodeGenConfigurationNode$JDBCConnectorTarget' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', ], ], 'JDBCDataType' => [ 'base' => NULL, 'refs' => [ 'JDBCDataTypeMapping$key' => NULL, ], ], 'JDBCDataTypeMapping' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorOptions$DataTypeMapping' => 'Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"} maps data fields of JDBC type FLOAT into the Java String type by calling the ResultSet.getString() method of the driver, and uses it to build the Glue record. The ResultSet object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
Specifies a JDBC data store to crawl.
', 'refs' => [ 'JdbcTargetList$member' => NULL, ], ], 'JdbcTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$JdbcTargets' => 'Specifies JDBC targets.
', ], ], 'Job' => [ 'base' => 'Specifies a job definition.
', 'refs' => [ 'GetJobResponse$Job' => 'The requested job definition.
', 'JobList$member' => NULL, ], ], 'JobBookmarkEntry' => [ 'base' => 'Defines a point that a job can resume processing.
', 'refs' => [ 'GetJobBookmarkResponse$JobBookmarkEntry' => 'A structure that defines a point that a job can resume processing.
', 'ResetJobBookmarkResponse$JobBookmarkEntry' => 'The reset bookmark entry.
', ], ], 'JobBookmarksEncryption' => [ 'base' => 'Specifies how job bookmark data should be encrypted.
', 'refs' => [ 'EncryptionConfiguration$JobBookmarksEncryption' => 'The encryption configuration for job bookmarks.
', ], ], 'JobBookmarksEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'JobBookmarksEncryption$JobBookmarksEncryptionMode' => 'The encryption mode to use for job bookmarks data.
', ], ], 'JobCommand' => [ 'base' => 'Specifies code that runs when a job is run.
', 'refs' => [ 'CreateJobRequest$Command' => 'The JobCommand that runs this job.
The JobCommand that runs this job.
The JobCommand that runs this job (required).
A list of job definitions.
', 'GetJobsResponse$Jobs' => 'A list of job definitions.
', ], ], 'JobName' => [ 'base' => NULL, 'refs' => [ 'GetJobBookmarkRequest$JobName' => 'The name of the job in question.
', 'JobBookmarkEntry$JobName' => 'The name of the job in question.
', 'ResetJobBookmarkRequest$JobName' => 'The name of the job in question.
', ], ], 'JobNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetJobsRequest$JobNames' => 'A list of job names, which might be the names returned from the ListJobs operation.
A list of names of jobs not found.
', 'ListJobsResponse$JobNames' => 'The names of all jobs in the account, or the jobs with the specified tags.
', ], ], 'JobNodeDetails' => [ 'base' => 'The details of a Job node present in the workflow.
', 'refs' => [ 'Node$JobDetails' => 'Details of the Job when the node represents a Job.
', ], ], 'JobRun' => [ 'base' => 'Contains information about a job run.
', 'refs' => [ 'GetJobRunResponse$JobRun' => 'The requested job-run metadata.
', 'JobRunList$member' => NULL, ], ], 'JobRunList' => [ 'base' => NULL, 'refs' => [ 'GetJobRunsResponse$JobRuns' => 'A list of job-run metadata objects.
', 'JobNodeDetails$JobRuns' => 'The information for the job runs represented by the job node.
', ], ], 'JobRunState' => [ 'base' => NULL, 'refs' => [ 'Condition$State' => 'The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED, STOPPED, FAILED, and TIMEOUT. The only crawler states that a trigger can listen for are SUCCEEDED, FAILED, and CANCELLED.
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
', ], ], 'JobUpdate' => [ 'base' => 'Specifies information used to update an existing job definition. The previous job definition is completely overwritten by this information.
', 'refs' => [ 'UpdateJobRequest$JobUpdate' => 'Specifies the values with which to update the job definition. Unspecified configuration is removed or reset to default values.
', ], ], 'Join' => [ 'base' => 'Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
', 'refs' => [ 'CodeGenConfigurationNode$Join' => 'Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
', ], ], 'JoinColumn' => [ 'base' => 'Specifies a column to be joined.
', 'refs' => [ 'JoinColumns$member' => NULL, ], ], 'JoinColumns' => [ 'base' => NULL, 'refs' => [ 'Join$Columns' => 'A list of the two columns to be joined.
', ], ], 'JoinType' => [ 'base' => NULL, 'refs' => [ 'Join$JoinType' => 'Specifies the type of join to be performed on the datasets.
', ], ], 'JsonClassifier' => [ 'base' => 'A classifier for JSON content.
A classifier for JSON content.
', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'CreateJsonClassifierRequest$JsonPath' => 'A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
The bookmark itself.
', ], ], 'KafkaStreamingSourceOptions' => [ 'base' => 'Additional options for streaming.
', 'refs' => [ 'CatalogKafkaSource$StreamingOptions' => 'Specifies the streaming options.
', 'DirectKafkaSource$StreamingOptions' => 'Specifies the streaming options.
', ], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'PartitionIndex$Keys' => 'The keys for the partition index.
', ], ], 'KeySchemaElement' => [ 'base' => 'A partition key pair consisting of a name and a type.
', 'refs' => [ 'KeySchemaElementList$member' => NULL, ], ], 'KeySchemaElementList' => [ 'base' => NULL, 'refs' => [ 'PartitionIndexDescriptor$Keys' => 'A list of one or more keys, as KeySchemaElement structures, for the partition index.
Additional options for the Amazon Kinesis streaming data source.
', 'refs' => [ 'CatalogKinesisSource$StreamingOptions' => 'Additional options for the Kinesis streaming data source.
', 'DirectKinesisSource$StreamingOptions' => 'Additional options for the Kinesis streaming data source.
', ], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEncryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', 'JobBookmarksEncryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', 'S3Encryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', ], ], 'LabelCount' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformResponse$LabelCount' => 'The number of labels available for this transform.
', 'MLTransform$LabelCount' => 'A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
', ], ], 'LabelingSetGenerationTaskRunProperties' => [ 'base' => 'Specifies configuration properties for a labeling set generation task run.
', 'refs' => [ 'TaskRunProperties$LabelingSetGenerationTaskRunProperties' => 'The configuration properties for a labeling set generation task run.
', ], ], 'LakeFormationConfiguration' => [ 'base' => 'Specifies Lake Formation configuration settings for the crawler.
', 'refs' => [ 'Crawler$LakeFormationConfiguration' => 'Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
', 'CreateCrawlerRequest$LakeFormationConfiguration' => 'Specifies Lake Formation configuration settings for the crawler.
', 'UpdateCrawlerRequest$LakeFormationConfiguration' => 'Specifies Lake Formation configuration settings for the crawler.
', ], ], 'Language' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$Language' => 'The programming language of the resulting code from the DAG.
', 'GetPlanRequest$Language' => 'The programming language of the code to perform the mapping.
', ], ], 'LastActiveDefinition' => [ 'base' => 'When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
', 'refs' => [ 'Blueprint$LastActiveDefinition' => 'When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
', ], ], 'LastCrawlInfo' => [ 'base' => 'Status and error information about the most recent crawl.
', 'refs' => [ 'Crawler$LastCrawl' => 'The status of the last crawl, and potentially error information if an error occurred.
', ], ], 'LastCrawlStatus' => [ 'base' => NULL, 'refs' => [ 'LastCrawlInfo$Status' => 'Status of the last crawl.
', ], ], 'LatestSchemaVersionBoolean' => [ 'base' => NULL, 'refs' => [ 'PutSchemaVersionMetadataResponse$LatestVersion' => 'The latest version of the schema.
', 'RemoveSchemaVersionMetadataResponse$LatestVersion' => 'The latest version of the schema.
', 'SchemaVersionNumber$LatestVersion' => 'The latest version available for the schema.
', ], ], 'LimitedPathList' => [ 'base' => NULL, 'refs' => [ 'DropDuplicates$Columns' => 'The name of the columns to be merged or removed if repeating.
', ], ], 'LimitedStringList' => [ 'base' => NULL, 'refs' => [ 'LimitedPathList$member' => NULL, ], ], 'LineageConfiguration' => [ 'base' => 'Specifies data lineage configuration settings for the crawler.
', 'refs' => [ 'Crawler$LineageConfiguration' => 'A configuration that specifies whether data lineage is enabled for the crawler.
', 'CreateCrawlerRequest$LineageConfiguration' => 'Specifies data lineage configuration settings for the crawler.
', 'UpdateCrawlerRequest$LineageConfiguration' => 'Specifies data lineage configuration settings for the crawler.
', ], ], 'ListBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomEntityTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomEntityTypesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityResultsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityResultsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRuleRecommendationRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRuleRecommendationRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetEvaluationRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetEvaluationRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMLTransformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMLTransformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSessionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSessionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStatementsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStatementsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => 'The location of resources.
', 'refs' => [ 'GetMappingRequest$Location' => 'Parameters for the mapping.
', 'GetPlanRequest$Location' => 'The parameters for the mapping.
', ], ], 'LocationMap' => [ 'base' => NULL, 'refs' => [ 'SkewedInfo$SkewedColumnValueLocationMaps' => 'A mapping of skewed values to the columns that contain them.
', ], ], 'LocationString' => [ 'base' => NULL, 'refs' => [ 'LocationStringList$member' => NULL, 'StorageDescriptor$Location' => 'The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
', ], ], 'LocationStringList' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$AdditionalLocations' => 'A list of locations that point to the path where a Delta table is located.
', ], ], 'LogGroup' => [ 'base' => NULL, 'refs' => [ 'Crawl$LogGroup' => 'The log group associated with the crawl.
', 'CrawlerHistory$LogGroup' => 'The log group associated with the crawl.
', 'LastCrawlInfo$LogGroup' => 'The log group for the last crawl.
', ], ], 'LogStream' => [ 'base' => NULL, 'refs' => [ 'Crawl$LogStream' => 'The log stream associated with the crawl.
', 'CrawlerHistory$LogStream' => 'The log stream associated with the crawl.
', 'LastCrawlInfo$LogStream' => 'The log stream for the last crawl.
', ], ], 'Logical' => [ 'base' => NULL, 'refs' => [ 'Predicate$Logical' => 'An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
', ], ], 'LogicalOperator' => [ 'base' => NULL, 'refs' => [ 'Condition$LogicalOperator' => 'A logical operator.
', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'LongColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'LongColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'LongColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for integer data columns.
', 'refs' => [ 'ColumnStatisticsData$LongColumnStatisticsData' => 'Long column statistics data.
', ], ], 'LongValue' => [ 'base' => NULL, 'refs' => [ 'Statement$StartedOn' => 'The unix time and date that the job definition was started.
', 'Statement$CompletedOn' => 'The unix time and date that the job definition was completed.
', ], ], 'MLTransform' => [ 'base' => 'A structure for a machine learning transform.
', 'refs' => [ 'TransformList$member' => NULL, ], ], 'MLTransformNotReadyException' => [ 'base' => 'The machine learning transform is not ready to run.
', 'refs' => [], ], 'MLUserDataEncryption' => [ 'base' => 'The encryption-at-rest settings of the transform that apply to accessing user data.
', 'refs' => [ 'TransformEncryption$MlUserDataEncryption' => 'An MLUserDataEncryption object containing the encryption mode and customer-provided KMS key ID.
The encryption mode applied to user data. Valid values are:
DISABLED: encryption is disabled
SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
The data inputs identified by their node names.
', 'EvaluateDataQualityMultiFrame$Inputs' => 'The inputs of your data quality evaluation. The first input in this list is the primary data source.
', 'SparkSQL$Inputs' => 'The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
', ], ], 'MapValue' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$Arguments' => 'A map of arguments used to configure the DevEndpoint.
The map of arguments used to configure this DevEndpoint.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
A map of arguments used to configure the DevEndpoint.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
The map of arguments to add the map of arguments used to configure the DevEndpoint.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
Specifies the mapping of data property keys.
', 'refs' => [ 'Mappings$member' => NULL, ], ], 'MappingEntry' => [ 'base' => 'Defines a mapping.
', 'refs' => [ 'MappingList$member' => NULL, ], ], 'MappingList' => [ 'base' => NULL, 'refs' => [ 'GetMappingResponse$Mapping' => 'A list of mappings to the specified targets.
', 'GetPlanRequest$Mapping' => 'The list of mappings from a source table to target tables.
', ], ], 'Mappings' => [ 'base' => NULL, 'refs' => [ 'ApplyMapping$Mapping' => 'Specifies the mapping of data property keys in the data source to data property keys in the data target.
', 'Mapping$Children' => 'Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping, but its FromPath will be the parent\'s FromPath plus the FromPath from this structure.
For the children part, suppose you have the structure:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
You can specify a Mapping that looks like:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
Indicates the value that will replace the detected entity.
', ], ], 'MatchCriteria' => [ 'base' => NULL, 'refs' => [ 'Connection$MatchCriteria' => 'A list of criteria that can be used in selecting this connection.
', 'ConnectionInput$MatchCriteria' => 'A list of criteria that can be used in selecting this connection.
', 'GetConnectionsFilter$MatchCriteria' => 'A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.
', ], ], 'MaxConcurrentRuns' => [ 'base' => NULL, 'refs' => [ 'ExecutionProperty$MaxConcurrentRuns' => 'The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
', ], ], 'MaxResultsNumber' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', 'ListSchemaVersionsInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', 'ListSchemasInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', ], ], 'MaxRetries' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$MaxRetries' => 'The maximum number of times to retry this job if it fails.
', 'Job$MaxRetries' => 'The maximum number of times to retry this job after a JobRun fails.
', 'JobUpdate$MaxRetries' => 'The maximum number of times to retry this job if it fails.
', ], ], 'Merge' => [ 'base' => 'Specifies a transform that merges a DynamicFrame with a staging DynamicFrame based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
Specifies a transform that merges a DynamicFrame with a staging DynamicFrame based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
The prefix for a CloudWatch message about this crawl.
', 'LastCrawlInfo$MessagePrefix' => 'The prefix for a message about this crawl.
', ], ], 'MessageString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => 'A message describing the problem.
', 'AlreadyExistsException$Message' => 'A message describing the problem.
', 'BlueprintRun$ErrorMessage' => 'Indicates any errors that are seen while running the blueprint.
', 'BlueprintRun$RollbackErrorMessage' => 'If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
', 'ConcurrentModificationException$Message' => 'A message describing the problem.
', 'ConcurrentRunsExceededException$Message' => 'A message describing the problem.
', 'ConditionCheckFailureException$Message' => 'A message describing the problem.
', 'ConflictException$Message' => 'A message describing the problem.
', 'CrawlerNotRunningException$Message' => 'A message describing the problem.
', 'CrawlerRunningException$Message' => 'A message describing the problem.
', 'CrawlerStoppingException$Message' => 'A message describing the problem.
', 'EntityNotFoundException$Message' => 'A message describing the problem.
', 'FederatedResourceAlreadyExistsException$Message' => 'The message describing the problem.
', 'FederationSourceException$Message' => 'The message describing the problem.
', 'FederationSourceRetryableException$Message' => NULL, 'GlueEncryptionException$Message' => 'The message describing the problem.
', 'IdempotentParameterMismatchException$Message' => 'A message describing the problem.
', 'IllegalBlueprintStateException$Message' => 'A message describing the problem.
', 'IllegalSessionStateException$Message' => 'A message describing the problem.
', 'IllegalWorkflowStateException$Message' => 'A message describing the problem.
', 'InternalServiceException$Message' => 'A message describing the problem.
', 'InvalidInputException$Message' => 'A message describing the problem.
', 'InvalidStateException$Message' => 'A message describing the problem.
', 'MLTransformNotReadyException$Message' => 'A message describing the problem.
', 'NoScheduleException$Message' => 'A message describing the problem.
', 'OperationTimeoutException$Message' => 'A message describing the problem.
', 'PermissionTypeMismatchException$Message' => 'There is a mismatch between the SupportedPermissionType used in the query request and the permissions defined on the target table.
', 'ResourceNotReadyException$Message' => 'A message describing the problem.
', 'ResourceNumberLimitExceededException$Message' => 'A message describing the problem.
', 'SchedulerNotRunningException$Message' => 'A message describing the problem.
', 'SchedulerRunningException$Message' => 'A message describing the problem.
', 'SchedulerTransitioningException$Message' => 'A message describing the problem.
', 'ValidationException$Message' => 'A message describing the problem.
', 'VersionMismatchException$Message' => 'A message describing the problem.
', ], ], 'MetadataInfo' => [ 'base' => 'A structure containing metadata information for a schema version.
', 'refs' => [ 'MetadataInfoMap$value' => NULL, ], ], 'MetadataInfoMap' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataResponse$MetadataInfoMap' => 'A map of a metadata key and associated values.
', ], ], 'MetadataKeyString' => [ 'base' => NULL, 'refs' => [ 'MetadataInfoMap$key' => NULL, 'MetadataKeyValuePair$MetadataKey' => 'A metadata key.
', 'PutSchemaVersionMetadataResponse$MetadataKey' => 'The metadata key.
', 'RemoveSchemaVersionMetadataResponse$MetadataKey' => 'The metadata key.
', ], ], 'MetadataKeyValuePair' => [ 'base' => 'A structure containing a key value pair for metadata.
', 'refs' => [ 'MetadataList$member' => NULL, 'PutSchemaVersionMetadataInput$MetadataKeyValue' => 'The metadata key\'s corresponding value.
', 'RemoveSchemaVersionMetadataInput$MetadataKeyValue' => 'The value of the metadata key.
', ], ], 'MetadataList' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataInput$MetadataList' => 'Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
', ], ], 'MetadataOperation' => [ 'base' => NULL, 'refs' => [ 'IcebergInput$MetadataOperation' => 'A required metadata operation. Can only be set to CREATE.
The metadata key’s corresponding value.
', 'MetadataKeyValuePair$MetadataValue' => 'A metadata key’s corresponding value.
', 'OtherMetadataValueListItem$MetadataValue' => 'The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
', 'PutSchemaVersionMetadataResponse$MetadataValue' => 'The value of the metadata key.
', 'RemoveSchemaVersionMetadataResponse$MetadataValue' => 'The value of the metadata key.
', ], ], 'MicrosoftSQLServerCatalogSource' => [ 'base' => 'Specifies a Microsoft SQL server data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$MicrosoftSQLServerCatalogSource' => 'Specifies a Microsoft SQL server data source in the Glue Data Catalog.
', ], ], 'MicrosoftSQLServerCatalogTarget' => [ 'base' => 'Specifies a target that uses Microsoft SQL.
', 'refs' => [ 'CodeGenConfigurationNode$MicrosoftSQLServerCatalogTarget' => 'Specifies a target that uses Microsoft SQL.
', ], ], 'MillisecondsCount' => [ 'base' => NULL, 'refs' => [ 'Crawler$CrawlElapsedTime' => 'If the crawler is running, contains the total time elapsed since the last crawl began.
', ], ], 'MongoDBTarget' => [ 'base' => 'Specifies an Amazon DocumentDB or MongoDB data store to crawl.
', 'refs' => [ 'MongoDBTargetList$member' => NULL, ], ], 'MongoDBTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$MongoDBTargets' => 'Specifies Amazon DocumentDB or MongoDB targets.
', ], ], 'MySQLCatalogSource' => [ 'base' => 'Specifies a MySQL data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$MySQLCatalogSource' => 'Specifies a MySQL data source in the Glue Data Catalog.
', ], ], 'MySQLCatalogTarget' => [ 'base' => 'Specifies a target that uses MySQL.
', 'refs' => [ 'CodeGenConfigurationNode$MySQLCatalogTarget' => 'Specifies a target that uses MySQL.
', ], ], 'NameString' => [ 'base' => NULL, 'refs' => [ 'Action$JobName' => 'The name of a job to be run.
', 'Action$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this action.
The name of the crawler to be used with this action.
', 'BatchCreatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be created.
', 'BatchCreatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be created.
', 'BatchDeletePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'BatchDeletePartitionRequest$TableName' => 'The name of the table that contains the partitions to be deleted.
', 'BatchDeleteTableNameList$member' => NULL, 'BatchDeleteTableRequest$DatabaseName' => 'The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.
', 'BatchDeleteTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'BatchDeleteTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'BatchGetPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'BatchGetPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'BatchStopJobRunError$JobName' => 'The name of the job definition that is used in the job run in question.
', 'BatchStopJobRunRequest$JobName' => 'The name of the job definition for which to stop job runs.
', 'BatchStopJobRunSuccessfulSubmission$JobName' => 'The name of the job definition used in the job run that was stopped.
', 'BatchUpdatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be updated.
', 'BatchUpdatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be updated.
', 'BlueprintRun$WorkflowName' => 'The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
', 'CancelStatementRequest$SessionId' => 'The Session ID of the statement to be cancelled.
', 'CatalogEntry$DatabaseName' => 'The database in which the table metadata resides.
', 'CatalogEntry$TableName' => 'The name of the table in question.
', 'CatalogImportStatus$ImportedBy' => 'The name of the person who initiated the migration.
', 'CatalogTablesList$member' => NULL, 'CatalogTarget$DatabaseName' => 'The name of the database to be synchronized.
', 'ClassifierNameList$member' => NULL, 'Column$Name' => 'The name of the Column.
The name of the column that failed.
', 'ColumnImportance$ColumnName' => 'The name of a column.
', 'ColumnRowFilter$ColumnName' => 'A string containing the name of the column.
', 'ColumnStatistics$ColumnName' => 'Name of column which statistics belong to.
', 'Condition$JobName' => 'The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
The name of the crawler to which this condition applies.
', 'Connection$Name' => 'The name of the connection definition.
', 'Connection$LastUpdatedBy' => 'The user, group, or role that last updated this connection definition.
', 'ConnectionInput$Name' => 'The name of the connection. Connection will not function as expected without a name.
', 'ConnectionPasswordEncryption$AwsKmsKeyId' => 'An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
', 'ContextWords$member' => NULL, 'Crawler$Name' => 'The name of the crawler.
', 'CrawlerHistory$Summary' => 'A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.
', 'CrawlerMetrics$CrawlerName' => 'The name of the crawler.
', 'CrawlerNameList$member' => NULL, 'CreateBlueprintResponse$Name' => 'Returns the name of the blueprint that was registered.
', 'CreateCrawlerRequest$Name' => 'Name of the new crawler.
', 'CreateCsvClassifierRequest$Name' => 'The name of the classifier.
', 'CreateCustomEntityTypeRequest$Name' => 'A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
', 'CreateCustomEntityTypeRequest$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'CreateCustomEntityTypeResponse$Name' => 'The name of the custom pattern you created.
', 'CreateDataQualityRulesetRequest$Name' => 'A unique name for the data quality ruleset.
', 'CreateDataQualityRulesetResponse$Name' => 'A unique name for the data quality ruleset.
', 'CreateDevEndpointRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this DevEndpoint.
The name of the SecurityConfiguration structure being used with this DevEndpoint.
The name of the new classifier.
', 'CreateJobRequest$Name' => 'The name you assign to this job definition. It must be unique in your account.
', 'CreateJobRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this job.
The unique name that was provided for this job definition.
', 'CreateJsonClassifierRequest$Name' => 'The name of the classifier.
', 'CreateMLTransformRequest$Name' => 'The unique name that you give the transform when you create it.
', 'CreatePartitionIndexRequest$DatabaseName' => 'Specifies the name of a database in which you want to create a partition index.
', 'CreatePartitionIndexRequest$TableName' => 'Specifies the name of a table in which you want to create a partition index.
', 'CreatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be created.
', 'CreatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be created.
', 'CreateSecurityConfigurationRequest$Name' => 'The name for the new security configuration.
', 'CreateSecurityConfigurationResponse$Name' => 'The name assigned to the new security configuration.
', 'CreateSessionRequest$Id' => 'The ID of the session request.
', 'CreateSessionRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with the session
', 'CreateTableRequest$DatabaseName' => 'The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.
', 'CreateTriggerRequest$Name' => 'The name of the trigger.
', 'CreateTriggerRequest$WorkflowName' => 'The name of the workflow associated with the trigger.
', 'CreateTriggerResponse$Name' => 'The name of the trigger.
', 'CreateUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database in which to create the function.
', 'CreateWorkflowRequest$Name' => 'The name to be assigned to the workflow. It should be unique within your account.
', 'CreateWorkflowResponse$Name' => 'The name of the workflow which was provided as part of the request.
', 'CreateXMLClassifierRequest$Name' => 'The name of the classifier.
', 'CsvClassifier$Name' => 'The name of the classifier.
', 'CsvHeader$member' => NULL, 'CustomDatatypes$member' => NULL, 'CustomEntityType$Name' => 'A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
', 'CustomEntityType$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'CustomEntityTypeNames$member' => NULL, 'DataQualityResult$RulesetName' => 'The name of the ruleset associated with the data quality result.
', 'DataQualityResult$JobName' => 'The job name associated with the data quality result, if any.
', 'DataQualityResultDescription$JobName' => 'The job name associated with the data quality result.
', 'DataQualityResultFilterCriteria$JobName' => 'Filter results by the specified job name.
', 'DataQualityRuleResult$Name' => 'The name of the data quality rule.
', 'DataQualityRulesetFilterCriteria$Name' => 'The name of the ruleset filter criteria.
', 'DataQualityRulesetListDetails$Name' => 'The name of the data quality ruleset.
', 'DataQualityTargetTable$TableName' => 'The name of the Glue table.
', 'DataQualityTargetTable$DatabaseName' => 'The name of the database where the Glue table exists.
', 'DataQualityTargetTable$CatalogId' => 'The catalog id where the Glue table exists.
', 'DataSourceMap$key' => NULL, 'Database$Name' => 'The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
', 'DatabaseIdentifier$DatabaseName' => 'The name of the catalog database.
', 'DatabaseIdentifier$Region' => 'Region of the target database.
', 'DatabaseInput$Name' => 'The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
', 'DeleteBlueprintRequest$Name' => 'The name of the blueprint to delete.
', 'DeleteBlueprintResponse$Name' => 'Returns the name of the blueprint that was deleted.
', 'DeleteClassifierRequest$Name' => 'Name of the classifier to remove.
', 'DeleteColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'DeleteColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'DeleteColumnStatisticsForPartitionRequest$ColumnName' => 'Name of the column.
', 'DeleteColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'DeleteColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'DeleteColumnStatisticsForTableRequest$ColumnName' => 'The name of the column.
', 'DeleteConnectionNameList$member' => NULL, 'DeleteConnectionRequest$ConnectionName' => 'The name of the connection to delete.
', 'DeleteCrawlerRequest$Name' => 'The name of the crawler to remove.
', 'DeleteCustomEntityTypeRequest$Name' => 'The name of the custom pattern that you want to delete.
', 'DeleteCustomEntityTypeResponse$Name' => 'The name of the custom pattern you deleted.
', 'DeleteDataQualityRulesetRequest$Name' => 'A name for the data quality ruleset.
', 'DeleteDatabaseRequest$Name' => 'The name of the database to delete. For Hive compatibility, this must be all lowercase.
', 'DeleteJobRequest$JobName' => 'The name of the job definition to delete.
', 'DeleteJobResponse$JobName' => 'The name of the job definition that was deleted.
', 'DeletePartitionIndexRequest$DatabaseName' => 'Specifies the name of a database from which you want to delete a partition index.
', 'DeletePartitionIndexRequest$TableName' => 'Specifies the name of a table from which you want to delete a partition index.
', 'DeletePartitionIndexRequest$IndexName' => 'The name of the partition index to be deleted.
', 'DeletePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'DeletePartitionRequest$TableName' => 'The name of the table that contains the partition to be deleted.
', 'DeleteSecurityConfigurationRequest$Name' => 'The name of the security configuration to delete.
', 'DeleteSessionRequest$Id' => 'The ID of the session to be deleted.
', 'DeleteSessionResponse$Id' => 'Returns the ID of the deleted session.
', 'DeleteTableRequest$DatabaseName' => 'The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableRequest$Name' => 'The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTriggerRequest$Name' => 'The name of the trigger to delete.
', 'DeleteTriggerResponse$Name' => 'The name of the trigger that was deleted.
', 'DeleteUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function is located.
', 'DeleteUserDefinedFunctionRequest$FunctionName' => 'The name of the function definition to be deleted.
', 'DeleteWorkflowRequest$Name' => 'Name of the workflow to be deleted.
', 'DeleteWorkflowResponse$Name' => 'Name of the workflow specified in input.
', 'DevEndpoint$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this DevEndpoint.
The unique of the node within the workflow where the edge starts.
', 'Edge$DestinationId' => 'The unique of the node within the workflow where the edge ends.
', 'EncryptionAtRest$SseAwsKmsKeyId' => 'The ID of the KMS key to use for encryption at rest.
', 'ErrorByName$key' => NULL, 'ErrorDetail$ErrorCode' => 'The code associated with this error.
', 'EvaluatedMetricsMap$key' => NULL, 'FederatedDatabase$ConnectionName' => 'The name of the connection to the external metastore.
', 'FederatedTable$ConnectionName' => 'The name of the connection to the external metastore.
', 'FindMatchesTaskRunProperties$JobName' => 'The name assigned to the job for the Find Matches task run.
', 'GetBlueprintRequest$Name' => 'The name of the blueprint.
', 'GetBlueprintRunsRequest$BlueprintName' => 'The name of the blueprint.
', 'GetClassifierRequest$Name' => 'Name of the classifier to retrieve.
', 'GetColumnNamesList$member' => NULL, 'GetColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'GetColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'GetConnectionRequest$Name' => 'The name of the connection definition to retrieve.
', 'GetCrawlerRequest$Name' => 'The name of the crawler to retrieve metadata for.
', 'GetCustomEntityTypeRequest$Name' => 'The name of the custom pattern that you want to retrieve.
', 'GetCustomEntityTypeResponse$Name' => 'The name of the custom pattern that you retrieved.
', 'GetCustomEntityTypeResponse$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'GetDataQualityResultResponse$RulesetName' => 'The name of the ruleset associated with the data quality result.
', 'GetDataQualityResultResponse$JobName' => 'The job name associated with the data quality result, if any.
', 'GetDataQualityRuleRecommendationRunResponse$CreatedRulesetName' => 'The name of the ruleset that was created by the run.
', 'GetDataQualityRulesetRequest$Name' => 'The name of the ruleset.
', 'GetDataQualityRulesetResponse$Name' => 'The name of the ruleset.
', 'GetDatabaseRequest$Name' => 'The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
', 'GetJobRequest$JobName' => 'The name of the job definition to retrieve.
', 'GetJobRunRequest$JobName' => 'Name of the job definition being run.
', 'GetJobRunsRequest$JobName' => 'The name of the job definition for which to retrieve all job runs.
', 'GetMLTransformResponse$Name' => 'The unique name given to the transform when it was created.
', 'GetPartitionIndexesRequest$DatabaseName' => 'Specifies the name of a database from which you want to retrieve partition indexes.
', 'GetPartitionIndexesRequest$TableName' => 'Specifies the name of a table for which you want to retrieve the partition indexes.
', 'GetPartitionRequest$DatabaseName' => 'The name of the catalog database where the partition resides.
', 'GetPartitionRequest$TableName' => 'The name of the partition\'s table.
', 'GetPartitionsRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetPartitionsRequest$TableName' => 'The name of the partitions\' table.
', 'GetSecurityConfigurationRequest$Name' => 'The name of the security configuration to retrieve.
', 'GetSessionRequest$Id' => 'The ID of the session.
', 'GetStatementRequest$SessionId' => 'The Session ID of the statement.
', 'GetTableRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableRequest$Name' => 'The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionsRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionsRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'GetTablesRequest$DatabaseName' => 'The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
', 'GetTriggerRequest$Name' => 'The name of the trigger to retrieve.
', 'GetTriggersRequest$DependentJobName' => 'The name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are returned.
', 'GetUnfilteredPartitionMetadataRequest$DatabaseName' => '(Required) Specifies the name of a database that contains the partition.
', 'GetUnfilteredPartitionMetadataRequest$TableName' => '(Required) Specifies the name of a table that contains the partition.
', 'GetUnfilteredPartitionsMetadataRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetUnfilteredPartitionsMetadataRequest$TableName' => 'The name of the table that contains the partition.
', 'GetUnfilteredTableMetadataRequest$DatabaseName' => '(Required) Specifies the name of a database that contains the table.
', 'GetUnfilteredTableMetadataRequest$Name' => '(Required) Specifies the name of a table for which you are requesting metadata.
', 'GetUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function is located.
', 'GetUserDefinedFunctionRequest$FunctionName' => 'The name of the function.
', 'GetUserDefinedFunctionsRequest$DatabaseName' => 'The name of the catalog database where the functions are located. If none is provided, functions from all the databases across the catalog will be returned.
', 'GetUserDefinedFunctionsRequest$Pattern' => 'An optional function-name pattern string that filters the function definitions returned.
', 'GetWorkflowRequest$Name' => 'The name of the workflow to retrieve.
', 'GetWorkflowRunPropertiesRequest$Name' => 'Name of the workflow which was run.
', 'GetWorkflowRunRequest$Name' => 'Name of the workflow being run.
', 'GetWorkflowRunsRequest$Name' => 'Name of the workflow whose metadata of runs should be returned.
', 'GlueTable$DatabaseName' => 'A database name in the Glue Data Catalog.
', 'GlueTable$TableName' => 'A table name in the Glue Data Catalog.
', 'GlueTable$CatalogId' => 'A unique identifier for the Glue Data Catalog.
', 'GlueTable$ConnectionName' => 'The name of the connection to the Glue Data Catalog.
', 'GlueTableAdditionalOptions$key' => NULL, 'GrokClassifier$Name' => 'The name of the classifier.
', 'Job$Name' => 'The name you assign to this job definition.
', 'Job$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this job.
The name of the trigger that started this job run.
', 'JobRun$JobName' => 'The name of the job definition being used in this run.
', 'JobRun$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this job run.
The name of the SecurityConfiguration structure to be used with this job.
The name of the classifier.
', 'KeyList$member' => NULL, 'KeySchemaElement$Name' => 'The name of a partition key.
', 'ListCrawlsRequest$CrawlerName' => 'The name of the crawler whose runs you want to retrieve.
', 'ListStatementsRequest$SessionId' => 'The Session ID of the statements.
', 'ListTriggersRequest$DependentJobName' => 'The name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is no such trigger, all triggers are returned.
', 'MLTransform$Name' => 'A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
', 'MLUserDataEncryption$KmsKeyId' => 'The ID for the customer-provided KMS key.
', 'MatchCriteria$member' => NULL, 'NameStringList$member' => NULL, 'Node$Name' => 'The name of the Glue component represented by the node.
', 'Node$UniqueId' => 'The unique Id assigned to the node within the workflow.
', 'NodeIdList$member' => NULL, 'Order$Column' => 'The name of the column.
', 'Partition$DatabaseName' => 'The name of the catalog database in which to create the partition.
', 'Partition$TableName' => 'The name of the database table in which to create the partition.
', 'PartitionIndex$IndexName' => 'The name of the partition index.
', 'PartitionIndexDescriptor$IndexName' => 'The name of the partition index.
', 'PhysicalConnectionRequirements$SubnetId' => 'The subnet ID used by the connection.
', 'PhysicalConnectionRequirements$AvailabilityZone' => 'The connection\'s Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.
', 'Predecessor$JobName' => 'The name of the job definition used by the predecessor job run.
', 'PutWorkflowRunPropertiesRequest$Name' => 'Name of the workflow which was run.
', 'ResumeWorkflowRunRequest$Name' => 'The name of the workflow to resume.
', 'RulesetNames$member' => NULL, 'RunStatementRequest$SessionId' => 'The Session Id of the statement to be run.
', 'SecurityConfiguration$Name' => 'The name of the security configuration.
', 'SecurityGroupIdList$member' => NULL, 'SerDeInfo$Name' => 'Name of the SerDe.
', 'SerDeInfo$SerializationLibrary' => 'Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
The ID of the session.
', 'Session$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with the session.
', 'SessionCommand$Name' => 'Specifies the name of the SessionCommand. Can be \'glueetl\' or \'gluestreaming\'.
', 'SessionIdList$member' => NULL, 'StartCrawlerRequest$Name' => 'Name of the crawler to start.
', 'StartCrawlerScheduleRequest$CrawlerName' => 'Name of the crawler to schedule.
', 'StartDataQualityRuleRecommendationRunRequest$CreatedRulesetName' => 'A name for the ruleset.
', 'StartJobRunRequest$JobName' => 'The name of the job definition to use.
', 'StartJobRunRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this job run.
The name of the trigger to start.
', 'StartTriggerResponse$Name' => 'The name of the trigger that was started.
', 'StartWorkflowRunRequest$Name' => 'The name of the workflow to start.
', 'StopCrawlerRequest$Name' => 'Name of the crawler to stop.
', 'StopCrawlerScheduleRequest$CrawlerName' => 'Name of the crawler whose schedule state to set.
', 'StopSessionRequest$Id' => 'The ID of the session to be stopped.
', 'StopSessionResponse$Id' => 'Returns the Id of the stopped session.
', 'StopTriggerRequest$Name' => 'The name of the trigger to stop.
', 'StopTriggerResponse$Name' => 'The name of the trigger that was stopped.
', 'StopWorkflowRunRequest$Name' => 'The name of the workflow to stop.
', 'Table$Name' => 'The table name. For Hive compatibility, this must be entirely lowercase.
', 'Table$DatabaseName' => 'The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
', 'Table$Owner' => 'The owner of the table.
', 'Table$CreatedBy' => 'The person or entity who created the table.
', 'TableError$TableName' => 'The name of the table. For Hive compatibility, this must be entirely lowercase.
', 'TableIdentifier$DatabaseName' => 'The name of the catalog database that contains the target table.
', 'TableIdentifier$Name' => 'The name of the target table.
', 'TableIdentifier$Region' => 'Region of the target table.
', 'TableInput$Name' => 'The table name. For Hive compatibility, this is folded to lowercase when it is stored.
', 'TableInput$Owner' => 'The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'TableVersionError$TableName' => 'The name of the table in question.
', 'TransformEncryption$TaskRunSecurityConfigurationName' => 'The name of the security configuration.
', 'TransformFilterCriteria$Name' => 'A unique transform name that is used to filter the machine learning transforms.
', 'Trigger$Name' => 'The name of the trigger.
', 'Trigger$WorkflowName' => 'The name of the workflow associated with the trigger.
', 'TriggerNameList$member' => NULL, 'TriggerUpdate$Name' => 'Reserved for future use.
', 'UpdateBlueprintResponse$Name' => 'Returns the name of the blueprint that was updated.
', 'UpdateColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'UpdateColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'UpdateColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'UpdateColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'UpdateConnectionRequest$Name' => 'The name of the connection definition to update.
', 'UpdateCrawlerRequest$Name' => 'Name of the new crawler.
', 'UpdateCrawlerScheduleRequest$CrawlerName' => 'The name of the crawler whose schedule to update.
', 'UpdateCsvClassifierRequest$Name' => 'The name of the classifier.
', 'UpdateDataQualityRulesetRequest$Name' => 'The name of the data quality ruleset.
', 'UpdateDataQualityRulesetResponse$Name' => 'The name of the data quality ruleset.
', 'UpdateDatabaseRequest$Name' => 'The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
', 'UpdateGrokClassifierRequest$Name' => 'The name of the GrokClassifier.
The name of the Glue job to be synchronized to or from the remote repository.
', 'UpdateJobFromSourceControlRequest$RepositoryName' => 'The name of the remote repository that contains the job artifacts.
', 'UpdateJobFromSourceControlRequest$RepositoryOwner' => 'The owner of the remote repository that contains the job artifacts.
', 'UpdateJobFromSourceControlRequest$BranchName' => 'An optional branch in the remote repository.
', 'UpdateJobFromSourceControlRequest$Folder' => 'An optional folder in the remote repository.
', 'UpdateJobFromSourceControlResponse$JobName' => 'The name of the Glue job.
', 'UpdateJobRequest$JobName' => 'The name of the job definition to update.
', 'UpdateJobResponse$JobName' => 'Returns the name of the updated job definition.
', 'UpdateJsonClassifierRequest$Name' => 'The name of the classifier.
', 'UpdateMLTransformRequest$Name' => 'The unique name that you gave the transform when you created it.
', 'UpdatePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'UpdatePartitionRequest$TableName' => 'The name of the table in which the partition to be updated is located.
', 'UpdateSourceControlFromJobRequest$JobName' => 'The name of the Glue job to be synchronized to or from the remote repository.
', 'UpdateSourceControlFromJobRequest$RepositoryName' => 'The name of the remote repository that contains the job artifacts.
', 'UpdateSourceControlFromJobRequest$RepositoryOwner' => 'The owner of the remote repository that contains the job artifacts.
', 'UpdateSourceControlFromJobRequest$BranchName' => 'An optional branch in the remote repository.
', 'UpdateSourceControlFromJobRequest$Folder' => 'An optional folder in the remote repository.
', 'UpdateSourceControlFromJobResponse$JobName' => 'The name of the Glue job.
', 'UpdateTableRequest$DatabaseName' => 'The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'UpdateTriggerRequest$Name' => 'The name of the trigger to update.
', 'UpdateUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function to be updated is located.
', 'UpdateUserDefinedFunctionRequest$FunctionName' => 'The name of the function.
', 'UpdateWorkflowRequest$Name' => 'Name of the workflow to be updated.
', 'UpdateWorkflowResponse$Name' => 'The name of the workflow which was specified in input.
', 'UpdateXMLClassifierRequest$Name' => 'The name of the classifier.
', 'UserDefinedFunction$FunctionName' => 'The name of the function.
', 'UserDefinedFunction$DatabaseName' => 'The name of the catalog database that contains the function.
', 'UserDefinedFunction$ClassName' => 'The Java class that contains the function code.
', 'UserDefinedFunction$OwnerName' => 'The owner of the function.
', 'UserDefinedFunctionInput$FunctionName' => 'The name of the function.
', 'UserDefinedFunctionInput$ClassName' => 'The Java class that contains the function code.
', 'UserDefinedFunctionInput$OwnerName' => 'The owner of the function.
', 'Workflow$Name' => 'The name of the workflow.
', 'WorkflowNames$member' => NULL, 'WorkflowRun$Name' => 'Name of the workflow that was run.
', 'XMLClassifier$Name' => 'The name of the classifier.
', ], ], 'NameStringList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionResponse$Succeeded' => 'A list of names of the connection definitions that were successfully deleted.
', 'GetUnfilteredPartitionMetadataResponse$AuthorizedColumns' => 'A list of column names that the user has been granted access to.
', 'GetUnfilteredTableMetadataResponse$AuthorizedColumns' => 'A list of column names that the user has been granted access to.
', 'SkewedInfo$SkewedColumnNames' => 'A list of names of columns that contain skewed values.
', 'StorageDescriptor$BucketColumns' => 'A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
', 'UnfilteredPartition$AuthorizedColumns' => 'The list of columns the user has permissions to access.
', ], ], 'NoScheduleException' => [ 'base' => 'There is no applicable schedule.
', 'refs' => [], ], 'Node' => [ 'base' => 'A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
', 'refs' => [ 'NodeList$member' => NULL, ], ], 'NodeId' => [ 'base' => NULL, 'refs' => [ 'CodeGenConfigurationNodes$key' => NULL, 'ManyInputs$member' => NULL, 'Merge$Source' => 'The source DynamicFrame that will be merged with a staging DynamicFrame.
A table, or a column in a table.
', 'TwoInputs$member' => NULL, ], ], 'NodeIdList' => [ 'base' => NULL, 'refs' => [ 'ResumeWorkflowRunRequest$NodeIds' => 'A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
', 'ResumeWorkflowRunResponse$NodeIds' => 'A list of the node IDs for the nodes that were actually restarted.
', ], ], 'NodeList' => [ 'base' => NULL, 'refs' => [ 'WorkflowGraph$Nodes' => 'A list of the the Glue components belong to the workflow represented as nodes.
', ], ], 'NodeName' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Name' => 'The name of the transform node.
', 'AmazonRedshiftSource$Name' => 'The name of the Amazon Redshift source.
', 'AmazonRedshiftTarget$Name' => 'The name of the Amazon Redshift target.
', 'ApplyMapping$Name' => 'The name of the transform node.
', 'AthenaConnectorSource$Name' => 'The name of the data source.
', 'BasicCatalogTarget$Name' => 'The name of your data target.
', 'CatalogDeltaSource$Name' => 'The name of the Delta Lake data source.
', 'CatalogHudiSource$Name' => 'The name of the Hudi data source.
', 'CatalogKafkaSource$Name' => 'The name of the data store.
', 'CatalogKinesisSource$Name' => 'The name of the data source.
', 'CatalogSource$Name' => 'The name of the data store.
', 'CustomCode$Name' => 'The name of the transform node.
', 'DQDLAliases$key' => NULL, 'DirectJDBCSource$Name' => 'The name of the JDBC source connection.
', 'DirectKafkaSource$Name' => 'The name of the data store.
', 'DirectKinesisSource$Name' => 'The name of the data source.
', 'DropDuplicates$Name' => 'The name of the transform node.
', 'DropFields$Name' => 'The name of the transform node.
', 'DropNullFields$Name' => 'The name of the transform node.
', 'DynamoDBCatalogSource$Name' => 'The name of the data source.
', 'EvaluateDataQuality$Name' => 'The name of the data quality evaluation.
', 'EvaluateDataQualityMultiFrame$Name' => 'The name of the data quality evaluation.
', 'FillMissingValues$Name' => 'The name of the transform node.
', 'Filter$Name' => 'The name of the transform node.
', 'GovernedCatalogSource$Name' => 'The name of the data store.
', 'GovernedCatalogTarget$Name' => 'The name of the data target.
', 'JDBCConnectorSource$Name' => 'The name of the data source.
', 'JDBCConnectorTarget$Name' => 'The name of the data target.
', 'Join$Name' => 'The name of the transform node.
', 'Merge$Name' => 'The name of the transform node.
', 'MicrosoftSQLServerCatalogSource$Name' => 'The name of the data source.
', 'MicrosoftSQLServerCatalogTarget$Name' => 'The name of the data target.
', 'MySQLCatalogSource$Name' => 'The name of the data source.
', 'MySQLCatalogTarget$Name' => 'The name of the data target.
', 'OracleSQLCatalogSource$Name' => 'The name of the data source.
', 'OracleSQLCatalogTarget$Name' => 'The name of the data target.
', 'PIIDetection$Name' => 'The name of the transform node.
', 'PostgreSQLCatalogSource$Name' => 'The name of the data source.
', 'PostgreSQLCatalogTarget$Name' => 'The name of the data target.
', 'Recipe$Name' => 'The name of the Glue Studio node.
', 'RedshiftSource$Name' => 'The name of the Amazon Redshift data store.
', 'RedshiftTarget$Name' => 'The name of the data target.
', 'RelationalCatalogSource$Name' => 'The name of the data source.
', 'RenameField$Name' => 'The name of the transform node.
', 'S3CatalogDeltaSource$Name' => 'The name of the Delta Lake data source.
', 'S3CatalogHudiSource$Name' => 'The name of the Hudi data source.
', 'S3CatalogSource$Name' => 'The name of the data store.
', 'S3CatalogTarget$Name' => 'The name of the data target.
', 'S3CsvSource$Name' => 'The name of the data store.
', 'S3DeltaCatalogTarget$Name' => 'The name of the data target.
', 'S3DeltaDirectTarget$Name' => 'The name of the data target.
', 'S3DeltaSource$Name' => 'The name of the Delta Lake source.
', 'S3DirectTarget$Name' => 'The name of the data target.
', 'S3GlueParquetTarget$Name' => 'The name of the data target.
', 'S3HudiCatalogTarget$Name' => 'The name of the data target.
', 'S3HudiDirectTarget$Name' => 'The name of the data target.
', 'S3HudiSource$Name' => 'The name of the Hudi source.
', 'S3JsonSource$Name' => 'The name of the data store.
', 'S3ParquetSource$Name' => 'The name of the data store.
', 'SelectFields$Name' => 'The name of the transform node.
', 'SelectFromCollection$Name' => 'The name of the transform node.
', 'SnowflakeSource$Name' => 'The name of the Snowflake data source.
', 'SnowflakeTarget$Name' => 'The name of the Snowflake target.
', 'SparkConnectorSource$Name' => 'The name of the data source.
', 'SparkConnectorTarget$Name' => 'The name of the data target.
', 'SparkSQL$Name' => 'The name of the transform node.
', 'Spigot$Name' => 'The name of the transform node.
', 'SplitFields$Name' => 'The name of the transform node.
', 'Union$Name' => 'The name of the transform node.
', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'Node$Type' => 'The type of Glue component represented by the node.
', ], ], 'NonNegativeDouble' => [ 'base' => NULL, 'refs' => [ 'BinaryColumnStatisticsData$AverageLength' => 'The average bit sequence length in the column.
', 'CrawlerHistory$DPUHour' => 'The number of data processing units (DPU) used in hours for the crawl.
', 'CrawlerMetrics$TimeLeftSeconds' => 'The estimated time left to complete a running crawl.
', 'CrawlerMetrics$LastRuntimeSeconds' => 'The duration of the crawler\'s most recent run, in seconds.
', 'CrawlerMetrics$MedianRuntimeSeconds' => 'The median duration of this crawler\'s runs, in seconds.
', 'StringColumnStatisticsData$AverageLength' => 'The average string length in the column.
', ], ], 'NonNegativeInt' => [ 'base' => NULL, 'refs' => [ 'SelectFromCollection$Index' => 'The index for the DynamicFrame to be selected.
', ], ], 'NonNegativeInteger' => [ 'base' => NULL, 'refs' => [ 'CrawlerMetrics$TablesCreated' => 'The number of tables created by this crawler.
', 'CrawlerMetrics$TablesUpdated' => 'The number of tables updated by this crawler.
', 'CrawlerMetrics$TablesDeleted' => 'The number of tables deleted by this crawler.
', 'Segment$SegmentNumber' => 'The zero-based index number of the segment. For example, if the total number of segments is 4, SegmentNumber values range from 0 through 3.
The retention time for this table.
', 'TableInput$Retention' => 'The retention time for this table.
', ], ], 'NonNegativeLong' => [ 'base' => NULL, 'refs' => [ 'BinaryColumnStatisticsData$MaximumLength' => 'The size of the longest bit sequence in the column.
', 'BinaryColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'BooleanColumnStatisticsData$NumberOfTrues' => 'The number of true values in the column.
', 'BooleanColumnStatisticsData$NumberOfFalses' => 'The number of false values in the column.
', 'BooleanColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DateColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DateColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'DecimalColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DecimalColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'DoubleColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DoubleColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'LongColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'LongColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'StringColumnStatisticsData$MaximumLength' => 'The size of the longest string in the column.
', 'StringColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'StringColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', ], ], 'NotificationProperty' => [ 'base' => 'Specifies configuration properties of a notification.
', 'refs' => [ 'Action$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', 'CreateJobRequest$NotificationProperty' => 'Specifies configuration properties of a job notification.
', 'Job$NotificationProperty' => 'Specifies configuration properties of a job notification.
', 'JobRun$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', 'JobUpdate$NotificationProperty' => 'Specifies the configuration properties of a job notification.
', 'StartJobRunRequest$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', ], ], 'NotifyDelayAfter' => [ 'base' => NULL, 'refs' => [ 'NotificationProperty$NotifyDelayAfter' => 'After a job run starts, the number of minutes to wait before sending a job run delay notification.
', ], ], 'NullCheckBoxList' => [ 'base' => 'Represents whether certain values are recognized as null values for removal.
', 'refs' => [ 'DropNullFields$NullCheckBoxList' => 'A structure that represents whether certain values are recognized as null values for removal.
', ], ], 'NullValueField' => [ 'base' => 'Represents a custom null value such as a zeros or other value being used as a null placeholder unique to the dataset.
', 'refs' => [ 'NullValueFields$member' => NULL, ], ], 'NullValueFields' => [ 'base' => NULL, 'refs' => [ 'DropNullFields$NullTextList' => 'A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The DropNullFields transform removes custom null values only if both the value of the null placeholder and the datatype match the data.
All columns request for audit.
', 'BatchGetBlueprintsRequest$IncludeBlueprint' => 'Specifies whether or not to include the blueprint in the response.
', 'BatchGetBlueprintsRequest$IncludeParameterSpec' => 'Specifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.
', 'BatchGetWorkflowsRequest$IncludeGraph' => 'Specifies whether to include a graph when returning the workflow resource metadata.
', 'CreateCsvClassifierRequest$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true.
', 'CreateCsvClassifierRequest$AllowSingleColumn' => 'Enables the processing of files that contain only one column.
', 'CreateCsvClassifierRequest$CustomDatatypeConfigured' => 'Enables the configuration of custom datatypes.
', 'CsvClassifier$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true.
Enables the processing of files that contain only one column.
', 'CsvClassifier$CustomDatatypeConfigured' => 'Enables the custom datatype to be configured.
', 'DataQualityEvaluationRunAdditionalRunOptions$CloudWatchMetricsEnabled' => 'Whether or not to enable CloudWatch metrics.
', 'DeltaTarget$WriteManifest' => 'Specifies whether to write the manifest files to the Delta table path.
', 'DeltaTarget$CreateNativeDeltaTable' => 'Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
', 'DynamoDBTarget$scanAll' => 'Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
Indicates whether or not the exception relates to a federated source.
', 'FindMatchesParameters$EnforceProvidedLabels' => 'The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
', 'GetBlueprintRequest$IncludeBlueprint' => 'Specifies whether or not to include the blueprint in the response.
', 'GetBlueprintRequest$IncludeParameterSpec' => 'Specifies whether or not to include the parameter specification.
', 'GetWorkflowRequest$IncludeGraph' => 'Specifies whether to include a graph when returning the workflow resource metadata.
', 'GetWorkflowRunRequest$IncludeGraph' => 'Specifies whether to include the workflow graph in response or not.
', 'GetWorkflowRunsRequest$IncludeGraph' => 'Specifies whether to include the workflow graph in response or not.
', 'InvalidInputException$FromFederationSource' => 'Indicates whether or not the exception relates to a federated source.
', 'LakeFormationConfiguration$UseLakeFormationCredentials' => 'Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
', 'MongoDBTarget$ScanAll' => 'Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
Specifies not to trim values before identifying the type of column values. The default value is true.
', 'UpdateCsvClassifierRequest$AllowSingleColumn' => 'Enables the processing of files that contain only one column.
', 'UpdateCsvClassifierRequest$CustomDatatypeConfigured' => 'Specifies the configuration of custom datatypes.
', ], ], 'NullableDouble' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$MaxCapacity' => 'For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
', 'DynamoDBTarget$scanRate' => 'The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
', 'EvaluatedMetricsMap$value' => NULL, 'GetMLTransformResponse$MaxCapacity' => 'The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
This field populates only for Auto Scaling job runs, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X, 2 for G.2X, or 0.25 for G.025X workers). This value may be different than the executionEngineRuntime * MaxCapacity as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity. Therefore, it is possible that the value of DPUSeconds is less than executionEngineRuntime * MaxCapacity.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
', 'StartJobRunRequest$MaxCapacity' => 'For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The number of workers of a defined workerType that are allocated to the development endpoint.
The number of workers of a defined workerType that are allocated when a job runs.
The number of workers of a defined workerType that are allocated when this task runs.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
The maximum number of times to retry a task for this transform after a task run fails.
', 'CreateSessionRequest$NumberOfWorkers' => 'The number of workers of a defined WorkerType to use for the session.
You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', 'DataQualityRulesetListDetails$RuleCount' => 'The number of rules in the ruleset.
', 'DevEndpoint$NumberOfWorkers' => 'The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The number of G.1X workers to be used in the run. The default is 5.
The number of G.1X workers to be used in the run. The default is 5.
The number of workers of a defined workerType that are allocated when this task runs.
The maximum number of times to retry a task for this transform after a task run fails.
', 'HudiTarget$MaximumTraversalDepth' => 'The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
', 'IcebergTarget$MaximumTraversalDepth' => 'The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
', 'Job$NumberOfWorkers' => 'The number of workers of a defined workerType that are allocated when a job runs.
The number of workers of a defined workerType that are allocated when a job runs.
The number of workers of a defined workerType that are allocated when a job runs.
The number of workers of a defined workerType that are allocated when a task of the transform runs.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
', 'StartDataQualityRuleRecommendationRunRequest$NumberOfWorkers' => 'The number of G.1X workers to be used in the run. The default is 5.
The number of G.1X workers to be used in the run. The default is 5.
The number of workers of a defined workerType that are allocated when a job runs.
Number of events in the batch.
', 'StartingEventBatchCondition$BatchWindow' => 'Duration of the batch window in seconds.
', 'UpdateMLTransformRequest$NumberOfWorkers' => 'The number of workers of a defined workerType that are allocated when this task runs.
The maximum number of times to retry a task for this transform after a task run fails.
', 'UpdateWorkflowRequest$MaxConcurrentRuns' => 'You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', 'Workflow$MaxConcurrentRuns' => 'You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', ], ], 'OneInput' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Inputs' => 'Specifies the fields and rows to use as inputs for the aggregate transform.
', 'AmazonRedshiftTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'ApplyMapping$Inputs' => 'The data inputs identified by their node names.
', 'BasicCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'DropDuplicates$Inputs' => 'The data inputs identified by their node names.
', 'DropFields$Inputs' => 'The data inputs identified by their node names.
', 'DropNullFields$Inputs' => 'The data inputs identified by their node names.
', 'DynamicTransform$Inputs' => 'Specifies the inputs for the dynamic transform that are required.
', 'EvaluateDataQuality$Inputs' => 'The inputs of your data quality evaluation.
', 'FillMissingValues$Inputs' => 'The data inputs identified by their node names.
', 'Filter$Inputs' => 'The data inputs identified by their node names.
', 'GovernedCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'JDBCConnectorTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'MicrosoftSQLServerCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'MySQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'OracleSQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'PIIDetection$Inputs' => 'The node ID inputs to the transform.
', 'PostgreSQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'Recipe$Inputs' => 'The nodes that are inputs to the recipe node, identified by id.
', 'RedshiftTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'RenameField$Inputs' => 'The data inputs identified by their node names.
', 'S3CatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DeltaCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DeltaDirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3GlueParquetTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3HudiCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3HudiDirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'SelectFields$Inputs' => 'The data inputs identified by their node names.
', 'SelectFromCollection$Inputs' => 'The data inputs identified by their node names.
', 'SnowflakeTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'SparkConnectorTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'Spigot$Inputs' => 'The data inputs identified by their node names.
', 'SplitFields$Inputs' => 'The data inputs identified by their node names.
', ], ], 'OpenTableFormatInput' => [ 'base' => 'A structure representing an open format table.
', 'refs' => [ 'CreateTableRequest$OpenTableFormatInput' => 'Specifies an OpenTableFormatInput structure when creating an open format table.
The operation timed out.
', 'refs' => [], ], 'Option' => [ 'base' => 'Specifies an option value.
', 'refs' => [ 'AmazonRedshiftNodeData$Connection' => 'The Glue connection to the Redshift cluster.
', 'AmazonRedshiftNodeData$Schema' => 'The Redshift schema name when working with a direct connection.
', 'AmazonRedshiftNodeData$Table' => 'The Redshift table name when working with a direct connection.
', 'AmazonRedshiftNodeData$CatalogDatabase' => 'The name of the Glue Data Catalog database when working with a data catalog.
', 'AmazonRedshiftNodeData$CatalogTable' => 'The Glue Data Catalog table name when working with a data catalog.
', 'AmazonRedshiftNodeData$IamRole' => 'Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
', 'OptionList$member' => NULL, 'SnowflakeNodeData$Connection' => 'Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
', 'SnowflakeNodeData$IamRole' => 'Not currently used.
', ], ], 'OptionList' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$TableSchema' => 'The array of schema output for a given node.
', 'AmazonRedshiftNodeData$SelectedColumns' => 'The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
', 'SnowflakeNodeData$SelectedColumns' => 'Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value, label and description keys. Each structure describes a column.
Manually defines the target schema for the node. A list of structures with value , label and description keys. Each structure defines a column.
Specifies an Oracle data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$OracleSQLCatalogSource' => 'Specifies an Oracle data source in the Glue Data Catalog.
', ], ], 'OracleSQLCatalogTarget' => [ 'base' => 'Specifies a target that uses Oracle SQL.
', 'refs' => [ 'CodeGenConfigurationNode$OracleSQLCatalogTarget' => 'Specifies a target that uses Oracle SQL.
', ], ], 'OrchestrationArgumentsMap' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$DefaultArguments' => 'A map array of key-value pairs. Max is 75 pairs.
', 'Session$DefaultArguments' => 'A map array of key-value pairs. Max is 75 pairs.
', ], ], 'OrchestrationArgumentsValue' => [ 'base' => NULL, 'refs' => [ 'OrchestrationArgumentsMap$value' => NULL, ], ], 'OrchestrationIAMRoleArn' => [ 'base' => NULL, 'refs' => [ 'BlueprintRun$RoleArn' => 'The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
', 'StartBlueprintRunRequest$RoleArn' => 'Specifies the IAM role used to create the workflow.
', ], ], 'OrchestrationNameString' => [ 'base' => NULL, 'refs' => [ 'BatchGetBlueprintNames$member' => NULL, 'Blueprint$Name' => 'The name of the blueprint.
', 'BlueprintDetails$BlueprintName' => 'The name of the blueprint.
', 'BlueprintNames$member' => NULL, 'BlueprintRun$BlueprintName' => 'The name of the blueprint.
', 'CancelStatementRequest$RequestOrigin' => 'The origin of the request to cancel the statement.
', 'CreateBlueprintRequest$Name' => 'The name of the blueprint.
', 'CreateSessionRequest$RequestOrigin' => 'The origin of the request.
', 'DeleteSessionRequest$RequestOrigin' => 'The name of the origin of the delete session request.
', 'GetBlueprintRunRequest$BlueprintName' => 'The name of the blueprint.
', 'GetSessionRequest$RequestOrigin' => 'The origin of the request.
', 'GetStatementRequest$RequestOrigin' => 'The origin of the request.
', 'ListSessionsRequest$RequestOrigin' => 'The origin of the request.
', 'ListStatementsRequest$RequestOrigin' => 'The origin of the request to list statements.
', 'OrchestrationArgumentsMap$key' => NULL, 'RunStatementRequest$RequestOrigin' => 'The origin of the request.
', 'StartBlueprintRunRequest$BlueprintName' => 'The name of the blueprint.
', 'StopSessionRequest$RequestOrigin' => 'The origin of the request.
', 'UpdateBlueprintRequest$Name' => 'The name of the blueprint.
', ], ], 'OrchestrationRoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$Role' => 'The IAM Role ARN
', 'Session$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
', ], ], 'OrchestrationS3Location' => [ 'base' => NULL, 'refs' => [ 'CreateBlueprintRequest$BlueprintLocation' => 'Specifies a path in Amazon S3 where the blueprint is published.
', 'UpdateBlueprintRequest$BlueprintLocation' => 'Specifies a path in Amazon S3 where the blueprint is published.
', ], ], 'OrchestrationStatementCodeString' => [ 'base' => NULL, 'refs' => [ 'RunStatementRequest$Code' => 'The statement code to be run.
', ], ], 'OrchestrationStringList' => [ 'base' => NULL, 'refs' => [ 'ConnectionsList$Connections' => 'A list of connections used by the job.
', 'StatementOutput$Traceback' => 'The traceback of the output.
', ], ], 'OrchestrationToken' => [ 'base' => NULL, 'refs' => [ 'ListSessionsRequest$NextToken' => 'The token for the next set of results, or null if there are no more result.
', 'ListSessionsResponse$NextToken' => 'The token for the next set of results, or null if there are no more result.
', 'ListStatementsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListStatementsResponse$NextToken' => 'A continuation token, if not all statements have yet been returned.
', ], ], 'Order' => [ 'base' => 'Specifies the sort order of a sorted column.
', 'refs' => [ 'OrderList$member' => NULL, ], ], 'OrderList' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$SortColumns' => 'A list specifying the sort order of each bucket in the table.
', ], ], 'OtherMetadataValueList' => [ 'base' => NULL, 'refs' => [ 'MetadataInfo$OtherMetadataValueList' => 'Other metadata belonging to the same metadata key.
', ], ], 'OtherMetadataValueListItem' => [ 'base' => 'A structure containing other metadata for a schema version belonging to the same metadata key.
', 'refs' => [ 'OtherMetadataValueList$member' => NULL, ], ], 'PIIDetection' => [ 'base' => 'Specifies a transform that identifies, removes or masks PII data.
', 'refs' => [ 'CodeGenConfigurationNode$PIIDetection' => 'Specifies a transform that identifies, removes or masks PII data.
', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'GetBlueprintRunsRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetClassifiersRequest$MaxResults' => 'The size of the list to return (optional).
', 'GetConnectionsRequest$MaxResults' => 'The maximum number of connections to return in one response.
', 'GetCrawlerMetricsRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetCrawlersRequest$MaxResults' => 'The number of crawlers to return on each call.
', 'GetDevEndpointsRequest$MaxResults' => 'The maximum size of information to return.
', 'GetJobRunsRequest$MaxResults' => 'The maximum size of the response.
', 'GetJobsRequest$MaxResults' => 'The maximum size of the response.
', 'GetMLTaskRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetMLTransformsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetPartitionsRequest$MaxResults' => 'The maximum number of partitions to return in a single response.
', 'GetResourcePoliciesRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetSecurityConfigurationsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetTriggersRequest$MaxResults' => 'The maximum size of the response.
', 'GetUnfilteredPartitionsMetadataRequest$MaxResults' => 'The maximum number of partitions to return in a single response.
', 'GetWorkflowRunsRequest$MaxResults' => 'The maximum number of workflow runs to be included in the response.
', 'ListBlueprintsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListCrawlersRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListCrawlsRequest$MaxResults' => 'The maximum number of results to return. The default is 20, and maximum is 100.
', 'ListCustomEntityTypesRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityResultsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRuleRecommendationRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRulesetEvaluationRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRulesetsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDevEndpointsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListJobsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListMLTransformsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListSessionsRequest$MaxResults' => 'The maximum number of results.
', 'ListTriggersRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListWorkflowsRequest$MaxResults' => 'The maximum size of a list to return.
', 'SearchTablesRequest$MaxResults' => 'The maximum number of tables to return in a single response.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'GetMLTaskRunsRequest$NextToken' => 'A token for pagination of the results. The default is empty.
', 'GetMLTaskRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'GetMLTransformsRequest$NextToken' => 'A paginated token to offset the results.
', 'GetMLTransformsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListCustomEntityTypesRequest$NextToken' => 'A paginated token to offset the results.
', 'ListCustomEntityTypesResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityResultsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityResultsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRuleRecommendationRunsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRuleRecommendationRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRulesetEvaluationRunsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRulesetEvaluationRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRulesetsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRulesetsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListMLTransformsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListMLTransformsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', ], ], 'ParamType' => [ 'base' => NULL, 'refs' => [ 'TransformConfigParameter$Type' => 'Specifies the parameter type in the config file of the dynamic transform.
', 'TransformConfigParameter$ListType' => 'Specifies the list type of the parameter in the config file of the dynamic transform.
', ], ], 'ParametersMap' => [ 'base' => NULL, 'refs' => [ 'Column$Parameters' => 'These key-value pairs define properties associated with the column.
', 'Database$Parameters' => 'These key-value pairs define parameters and properties of the database.
', 'DatabaseInput$Parameters' => 'These key-value pairs define parameters and properties of the database.
These key-value pairs define parameters and properties of the database.
', 'Partition$Parameters' => 'These key-value pairs define partition parameters.
', 'PartitionInput$Parameters' => 'These key-value pairs define partition parameters.
', 'SerDeInfo$Parameters' => 'These key-value pairs define initialization parameters for the SerDe.
', 'StorageDescriptor$Parameters' => 'The user-supplied properties in key-value form.
', 'Table$Parameters' => 'These key-value pairs define properties associated with the table.
', 'TableInput$Parameters' => 'These key-value pairs define properties associated with the table.
', ], ], 'ParametersMapValue' => [ 'base' => NULL, 'refs' => [ 'ParametersMap$value' => NULL, ], ], 'ParquetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3GlueParquetTarget$Compression' => '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 how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip").
Represents a slice of table data.
', 'refs' => [ 'GetPartitionResponse$Partition' => 'The requested information, in the form of a Partition object.
A Partition object containing the partition metadata.
', 'PartitionList$member' => NULL, 'UnfilteredPartition$Partition' => 'The partition object.
', ], ], 'PartitionError' => [ 'base' => 'Contains information about a partition error.
', 'refs' => [ 'PartitionErrors$member' => NULL, ], ], 'PartitionErrors' => [ 'base' => NULL, 'refs' => [ 'BatchCreatePartitionResponse$Errors' => 'The errors encountered when trying to create the requested partitions.
', 'BatchDeletePartitionResponse$Errors' => 'The errors encountered when trying to delete the requested partitions.
', ], ], 'PartitionIndex' => [ 'base' => 'A structure for a partition index.
', 'refs' => [ 'CreatePartitionIndexRequest$PartitionIndex' => 'Specifies a PartitionIndex structure to create a partition index in an existing table.
A descriptor for a partition index in a table.
', 'refs' => [ 'PartitionIndexDescriptorList$member' => NULL, ], ], 'PartitionIndexDescriptorList' => [ 'base' => NULL, 'refs' => [ 'GetPartitionIndexesResponse$PartitionIndexDescriptorList' => 'A list of index descriptors.
', ], ], 'PartitionIndexList' => [ 'base' => NULL, 'refs' => [ 'CreateTableRequest$PartitionIndexes' => 'A list of partition indexes, PartitionIndex structures, to create in the table.
The status of the partition index.
The possible statuses are:
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
ACTIVE: The index creation succeeds.
FAILED: The index creation fails.
DELETING: The index is deleted from the list of indexes.
The structure used to create and update a partition.
', 'refs' => [ 'BatchUpdatePartitionRequestEntry$PartitionInput' => 'The structure used to update a partition.
', 'CreatePartitionRequest$PartitionInput' => 'A PartitionInput structure defining the partition to be created.
The new partition object to update the partition to.
The Values property can\'t be changed. If you want to change the partition key values for a partition, delete and recreate the partition.
A list of PartitionInput structures that define the partitions to be created.
A list of the requested partitions.
', 'GetPartitionsResponse$Partitions' => 'A list of requested partitions.
', ], ], 'PartitionValueList' => [ 'base' => 'Contains a list of values defining partitions.
', 'refs' => [ 'BackfillErroredPartitionsList$member' => NULL, 'BatchDeletePartitionValueList$member' => NULL, 'BatchGetPartitionValueList$member' => NULL, ], ], 'Path' => [ 'base' => NULL, 'refs' => [ 'DynamoDBTarget$Path' => 'The name of the DynamoDB table to crawl.
', 'JdbcTarget$Path' => 'The path of the JDBC target.
', 'MongoDBTarget$Path' => 'The path of the Amazon DocumentDB or MongoDB target (database/collection).
', 'PathList$member' => NULL, 'S3Target$Path' => 'The path to the Amazon S3 target.
', ], ], 'PathList' => [ 'base' => NULL, 'refs' => [ 'DeltaTarget$DeltaTables' => 'A list of the Amazon S3 paths to the Delta tables.
', 'HudiTarget$Paths' => 'An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
', 'HudiTarget$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'IcebergTarget$Paths' => 'One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'JdbcTarget$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'S3Target$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', ], ], 'Permission' => [ 'base' => NULL, 'refs' => [ 'PermissionList$member' => NULL, ], ], 'PermissionList' => [ 'base' => NULL, 'refs' => [ 'PrincipalPermissions$Permissions' => 'The permissions that are granted to the principal.
', ], ], 'PermissionType' => [ 'base' => NULL, 'refs' => [ 'PermissionTypeList$member' => NULL, ], ], 'PermissionTypeList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$SupportedPermissionTypes' => '(Required) A list of supported permission types.
', 'GetUnfilteredPartitionsMetadataRequest$SupportedPermissionTypes' => 'A list of supported permission types.
', 'GetUnfilteredTableMetadataRequest$SupportedPermissionTypes' => '(Required) A list of supported permission types.
', ], ], 'PermissionTypeMismatchException' => [ 'base' => 'The operation timed out.
', 'refs' => [], ], 'PhysicalConnectionRequirements' => [ 'base' => 'Specifies the physical requirements for a connection.
', 'refs' => [ 'Connection$PhysicalConnectionRequirements' => 'A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.
Indicates the type of PIIDetection transform.
', ], ], 'PolicyJsonString' => [ 'base' => NULL, 'refs' => [ 'GetResourcePolicyResponse$PolicyInJson' => 'Contains the requested policy document, in JSON format.
', 'GluePolicy$PolicyInJson' => 'Contains the requested policy document, in JSON format.
', 'PutResourcePolicyRequest$PolicyInJson' => 'Contains the policy document to set, in JSON format.
', ], ], 'PollingTime' => [ 'base' => NULL, 'refs' => [ 'StreamingDataPreviewOptions$PollingTime' => 'The polling time in milliseconds.
', ], ], 'PositiveLong' => [ 'base' => NULL, 'refs' => [ 'StreamingDataPreviewOptions$RecordPollingLimit' => 'The limit to the number of records polled.
', ], ], 'PostgreSQLCatalogSource' => [ 'base' => 'Specifies a PostgresSQL data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$PostgreSQLCatalogSource' => 'Specifies a PostgresSQL data source in the Glue Data Catalog.
', ], ], 'PostgreSQLCatalogTarget' => [ 'base' => 'Specifies a target that uses Postgres SQL.
', 'refs' => [ 'CodeGenConfigurationNode$PostgreSQLCatalogTarget' => 'Specifies a target that uses Postgres SQL.
', ], ], 'Predecessor' => [ 'base' => 'A job run that was used in the predicate of a conditional trigger that triggered this job run.
', 'refs' => [ 'PredecessorList$member' => NULL, ], ], 'PredecessorList' => [ 'base' => NULL, 'refs' => [ 'JobRun$PredecessorRuns' => 'A list of predecessors to this job run.
', ], ], 'Predicate' => [ 'base' => 'Defines the predicate of the trigger, which determines when it fires.
', 'refs' => [ 'CreateTriggerRequest$Predicate' => 'A predicate to specify when the new trigger should fire.
This field is required when the trigger type is CONDITIONAL.
The predicate of this trigger, which defines when it will fire.
', 'TriggerUpdate$Predicate' => 'The predicate of this trigger, which defines when it will fire.
', ], ], 'PredicateString' => [ 'base' => NULL, 'refs' => [ 'ColumnRowFilter$RowFilterExpression' => 'A string containing the row-level filter expression.
', 'GetPartitionsRequest$Expression' => 'An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume \'variable a\' holds 10 and \'variable b\' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING, to be compatible with the catalog partitions.
Sample API Call:
', 'GetUnfilteredPartitionsMetadataRequest$Expression' => 'An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume \'variable a\' holds 10 and \'variable b\' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
', ], ], 'PrincipalPermissions' => [ 'base' => 'Permissions granted to a principal.
', 'refs' => [ 'PrincipalPermissionsList$member' => NULL, ], ], 'PrincipalPermissionsList' => [ 'base' => NULL, 'refs' => [ 'Database$CreateTableDefaultPermissions' => 'Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
', 'DatabaseInput$CreateTableDefaultPermissions' => 'Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'UserDefinedFunction$OwnerType' => 'The owner type.
', 'UserDefinedFunctionInput$OwnerType' => 'The owner type.
', ], ], 'Prob' => [ 'base' => NULL, 'refs' => [ 'Spigot$Prob' => 'The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
', ], ], 'PropertyPredicate' => [ 'base' => 'Defines a property predicate.
', 'refs' => [ 'SearchPropertyPredicates$member' => NULL, ], ], 'PublicKeysList' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$PublicKeys' => 'A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
A list of public keys to be used by the DevEndpoints for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
The list of public keys for the DevEndpoint to use.
The list of public keys to be deleted from the DevEndpoint.
The Python script generated from the DAG.
', 'GetDataflowGraphRequest$PythonScript' => 'The Python script to transform.
', 'GetPlanResponse$PythonScript' => 'A Python script to perform the mapping.
', ], ], 'PythonVersionString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$PythonVersion' => 'The Python version being used to run a Python shell job. Allowed values are 2 or 3.
', 'SessionCommand$PythonVersion' => 'Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
', ], ], 'QuerySchemaVersionMetadataInput' => [ 'base' => NULL, 'refs' => [], ], 'QuerySchemaVersionMetadataMaxResults' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', ], ], 'QuerySchemaVersionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'QuoteChar' => [ 'base' => NULL, 'refs' => [ 'S3CsvSource$QuoteChar' => 'Specifies the character to use for quoting. The default is a double quote: \'"\'. Set this to -1 to turn off quoting entirely.
A Glue Studio node that uses a Glue DataBrew recipe in Glue jobs.
', 'refs' => [ 'CodeGenConfigurationNode$Recipe' => 'Specifies a Glue DataBrew recipe node.
', ], ], 'RecipeReference' => [ 'base' => 'A reference to a Glue DataBrew recipe.
', 'refs' => [ 'Recipe$RecipeReference' => 'A reference to the DataBrew recipe used by the node.
', ], ], 'RecipeVersion' => [ 'base' => NULL, 'refs' => [ 'RecipeReference$RecipeVersion' => 'The RecipeVersion of the DataBrew recipe.
', ], ], 'RecordsCount' => [ 'base' => NULL, 'refs' => [ 'ConfusionMatrix$NumTruePositives' => 'The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumFalsePositives' => 'The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumTrueNegatives' => 'The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumFalseNegatives' => 'The number of matches in the data that the transform didn\'t find, in the confusion matrix for your transform.
', ], ], 'RecrawlBehavior' => [ 'base' => NULL, 'refs' => [ 'RecrawlPolicy$RecrawlBehavior' => 'Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in Glue in the developer guide.
', 'refs' => [ 'Crawler$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', 'CreateCrawlerRequest$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', 'UpdateCrawlerRequest$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', ], ], 'RedshiftSource' => [ 'base' => 'Specifies an Amazon Redshift data store.
', 'refs' => [ 'CodeGenConfigurationNode$RedshiftSource' => 'Specifies an Amazon Redshift data store.
', ], ], 'RedshiftTarget' => [ 'base' => 'Specifies a target that uses Amazon Redshift.
', 'refs' => [ 'CodeGenConfigurationNode$RedshiftTarget' => 'Specifies a target that uses Amazon Redshift.
', ], ], 'RegisterSchemaVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'RegisterSchemaVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegistryId' => [ 'base' => 'A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'refs' => [ 'CreateSchemaInput$RegistryId' => ' This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.
This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'GetRegistryInput$RegistryId' => 'This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'ListSchemasInput$RegistryId' => 'A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'UpdateRegistryInput$RegistryId' => 'This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', ], ], 'RegistryListDefinition' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesResponse$Registries' => 'An array of RegistryDetailedListItem objects containing minimal details of each registry.
A structure containing the details for a registry.
', 'refs' => [ 'RegistryListDefinition$member' => NULL, ], ], 'RegistryStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistryResponse$Status' => 'The status of the registry. A successful operation will return the Deleting status.
The status of the registry.
', 'RegistryListItem$Status' => 'The status of the registry.
', ], ], 'RelationalCatalogSource' => [ 'base' => 'Specifies a Relational database data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$RelationalCatalogSource' => 'Specifies a relational catalog data store in the Glue Data Catalog.
', ], ], 'RemoveSchemaVersionMetadataInput' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSchemaVersionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenameField' => [ 'base' => 'Specifies a transform that renames a single data property key.
', 'refs' => [ 'CodeGenConfigurationNode$RenameField' => 'Specifies a transform that renames a single data property key.
', ], ], 'ReplaceBoolean' => [ 'base' => NULL, 'refs' => [ 'ImportLabelsTaskRunProperties$Replace' => 'Indicates whether to overwrite your existing labels.
', 'StartImportLabelsTaskRunRequest$ReplaceAllLabels' => 'Indicates whether to overwrite your existing labels.
', ], ], 'ResetJobBookmarkRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetJobBookmarkResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotReadyException' => [ 'base' => 'A resource was not ready for a transaction.
', 'refs' => [], ], 'ResourceNumberLimitExceededException' => [ 'base' => 'A resource numerical limit was exceeded.
', 'refs' => [], ], 'ResourceShareType' => [ 'base' => NULL, 'refs' => [ 'GetDatabasesRequest$ResourceShareType' => 'Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.
If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.
If set to FOREIGN, will list the databases shared with your account.
If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.
Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.
If set to FOREIGN, will search the tables shared with your account.
If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.
The type of the resource.
', ], ], 'ResourceUri' => [ 'base' => 'The URIs for function resources.
', 'refs' => [ 'ResourceUriList$member' => NULL, ], ], 'ResourceUriList' => [ 'base' => NULL, 'refs' => [ 'UserDefinedFunction$ResourceUris' => 'The resource URIs for the function.
', 'UserDefinedFunctionInput$ResourceUris' => 'The resource URIs for the function.
', ], ], 'ResumeWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResumeWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'Crawler$Role' => 'The Amazon Resource Name (ARN) of an IAM role that\'s used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
', 'CreateCrawlerRequest$Role' => 'The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
', 'UpdateCrawlerRequest$Role' => 'The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$RoleArn' => 'The IAM role for the DevEndpoint.
The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint.
The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint.
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
', 'CreateMLTransformRequest$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
An IAM role supplied to encrypt the results of the run.
', 'GetDataQualityRulesetEvaluationRunResponse$Role' => 'An IAM role supplied to encrypt the results of the run.
', 'GetMLTransformResponse$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
', 'Job$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
', 'JobUpdate$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
', 'MLTransform$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
An IAM role supplied to encrypt the results of the run.
', 'StartDataQualityRulesetEvaluationRunRequest$Role' => 'An IAM role supplied to encrypt the results of the run.
', 'UpdateMLTransformRequest$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
', ], ], 'RowTag' => [ 'base' => NULL, 'refs' => [ 'CreateXMLClassifierRequest$RowTag' => 'The XML tag designating the element that contains each record in an XML document being parsed. This can\'t identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
The XML tag designating the element that contains each record in an XML document being parsed. This cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
The XML tag designating the element that contains each record in an XML document being parsed. This can\'t identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
A list of ruleset names for the run.
', 'StartDataQualityRulesetEvaluationRunRequest$RulesetNames' => 'A list of ruleset names.
', ], ], 'RunId' => [ 'base' => NULL, 'refs' => [ 'GetJobBookmarkRequest$RunId' => 'The unique run identifier associated with this job run.
', 'JobBookmarkEntry$PreviousRunId' => 'The unique run identifier associated with the previous job run.
', 'JobBookmarkEntry$RunId' => 'The run ID number.
', 'ResetJobBookmarkRequest$RunId' => 'The unique run identifier associated with this job run.
', ], ], 'RunStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'RuntimeNameString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$Runtime' => 'In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Working with Ray jobs in the Glue Developer Guide.
', ], ], 'S3CatalogDeltaSource' => [ 'base' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogDeltaSource' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', ], ], 'S3CatalogHudiSource' => [ 'base' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog. The Hudi data source must be stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogHudiSource' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', ], ], 'S3CatalogSource' => [ 'base' => 'Specifies an Amazon S3 data store in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogSource' => 'Specifies an Amazon S3 data store in the Glue Data Catalog.
', ], ], 'S3CatalogTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogTarget' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', ], ], 'S3CsvSource' => [ 'base' => 'Specifies a command-separated value (CSV) data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CsvSource' => 'Specifies a command-separated value (CSV) data store stored in Amazon S3.
', ], ], 'S3DeltaCatalogTarget' => [ 'base' => 'Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaCatalogTarget' => 'Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
', ], ], 'S3DeltaDirectTarget' => [ 'base' => 'Specifies a target that writes to a Delta Lake data source in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaDirectTarget' => 'Specifies a target that writes to a Delta Lake data source in Amazon S3.
', ], ], 'S3DeltaSource' => [ 'base' => 'Specifies a Delta Lake data source stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaSource' => 'Specifies a Delta Lake data source stored in Amazon S3.
', ], ], 'S3DirectSourceAdditionalOptions' => [ 'base' => 'Specifies additional connection options for the Amazon S3 data store.
', 'refs' => [ 'S3CsvSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3DeltaSource$AdditionalOptions' => 'Specifies additional options for the connector.
', 'S3HudiSource$AdditionalOptions' => 'Specifies additional options for the connector.
', 'S3JsonSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3ParquetSource$AdditionalOptions' => 'Specifies additional connection options.
', ], ], 'S3DirectTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DirectTarget' => 'Specifies a data target that writes to Amazon S3.
', ], ], 'S3Encryption' => [ 'base' => 'Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
', 'refs' => [ 'S3EncryptionList$member' => NULL, ], ], 'S3EncryptionList' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$S3Encryption' => 'The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
', ], ], 'S3EncryptionMode' => [ 'base' => NULL, 'refs' => [ 'S3Encryption$S3EncryptionMode' => 'The encryption mode to use for Amazon S3 data.
', ], ], 'S3GlueParquetTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', 'refs' => [ 'CodeGenConfigurationNode$S3GlueParquetTarget' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', ], ], 'S3HudiCatalogTarget' => [ 'base' => 'Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiCatalogTarget' => 'Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
', ], ], 'S3HudiDirectTarget' => [ 'base' => 'Specifies a target that writes to a Hudi data source in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiDirectTarget' => 'Specifies a target that writes to a Hudi data source in Amazon S3.
', ], ], 'S3HudiSource' => [ 'base' => 'Specifies a Hudi data source stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiSource' => 'Specifies a Hudi data source stored in Amazon S3.
', ], ], 'S3JsonSource' => [ 'base' => 'Specifies a JSON data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3JsonSource' => 'Specifies a JSON data store stored in Amazon S3.
', ], ], 'S3ParquetSource' => [ 'base' => 'Specifies an Apache Parquet data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3ParquetSource' => 'Specifies an Apache Parquet data store stored in Amazon S3.
', ], ], 'S3SourceAdditionalOptions' => [ 'base' => 'Specifies additional connection options for the Amazon S3 data store.
', 'refs' => [ 'GovernedCatalogSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3CatalogSource$AdditionalOptions' => 'Specifies additional connection options.
', ], ], 'S3Target' => [ 'base' => 'Specifies a data store in Amazon Simple Storage Service (Amazon S3).
', 'refs' => [ 'S3TargetList$member' => NULL, ], ], 'S3TargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$S3Targets' => 'Specifies Amazon Simple Storage Service (Amazon S3) targets.
', ], ], 'ScalaCode' => [ 'base' => NULL, 'refs' => [ 'CreateScriptResponse$ScalaCode' => 'The Scala code generated from the DAG.
', 'GetPlanResponse$ScalaCode' => 'The Scala code to perform the mapping.
', ], ], 'Schedule' => [ 'base' => 'A scheduling object using a cron statement to schedule an event.
For scheduled crawlers, the schedule when the crawler runs.
', ], ], 'ScheduleState' => [ 'base' => NULL, 'refs' => [ 'Schedule$State' => 'The state of the schedule.
', ], ], 'SchedulerNotRunningException' => [ 'base' => 'The specified scheduler is not running.
', 'refs' => [], ], 'SchedulerRunningException' => [ 'base' => 'The specified scheduler is already running.
', 'refs' => [], ], 'SchedulerTransitioningException' => [ 'base' => 'The specified scheduler is transitioning.
', 'refs' => [], ], 'SchemaChangePolicy' => [ 'base' => 'A policy that specifies update and deletion behaviors for the crawler.
', 'refs' => [ 'Crawler$SchemaChangePolicy' => 'The policy that specifies update and delete behaviors for the crawler.
', 'CreateCrawlerRequest$SchemaChangePolicy' => 'The policy for the crawler\'s update and deletion behavior.
', 'UpdateCrawlerRequest$SchemaChangePolicy' => 'The policy for the crawler\'s update and deletion behavior.
', ], ], 'SchemaCheckpointNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$SchemaCheckpoint' => 'The version number of the checkpoint (the last time the compatibility mode was changed).
', 'GetSchemaResponse$SchemaCheckpoint' => 'The version number of the checkpoint (the last time the compatibility mode was changed).
', ], ], 'SchemaColumn' => [ 'base' => 'A key-value pair representing a column and data type that this transform can run against. The Schema parameter of the MLTransform may contain up to 100 of these structures.
The difference between schemas as a string in JsonPatch format.
', ], ], 'SchemaDefinitionString' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityInput$SchemaDefinition' => 'The definition of the schema that has to be validated.
', 'CreateSchemaInput$SchemaDefinition' => 'The schema definition using the DataFormat setting for SchemaName.
The definition of the schema for which schema details are required.
', 'GetSchemaVersionResponse$SchemaDefinition' => 'The schema definition for the schema ID.
', 'RegisterSchemaVersionInput$SchemaDefinition' => 'The schema definition using the DataFormat setting for the SchemaName.
Refers to SYNTAX_DIFF, which is the currently supported diff type.
The unique ID of the schema in the Glue schema registry.
', 'refs' => [ 'DeleteSchemaInput$SchemaId' => 'This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'DeleteSchemaVersionsInput$SchemaId' => 'This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'GetSchemaByDefinitionInput$SchemaId' => 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
The unique ID for the schema.
', 'QuerySchemaVersionMetadataInput$SchemaId' => 'A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'RegisterSchemaVersionInput$SchemaId' => 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'SchemaReference$SchemaId' => 'A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.
An array of SchemaListItem objects containing details of each schema.
An object that contains minimal details for a schema.
', 'refs' => [ 'SchemaListDefinition$member' => NULL, ], ], 'SchemaPathString' => [ 'base' => NULL, 'refs' => [ 'MappingEntry$SourcePath' => 'The source path.
', 'MappingEntry$TargetPath' => 'The target path.
', ], ], 'SchemaReference' => [ 'base' => 'An object that references a schema stored in the Glue Schema Registry.
', 'refs' => [ 'StorageDescriptor$SchemaReference' => 'An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
', ], ], 'SchemaRegistryNameString' => [ 'base' => NULL, 'refs' => [ 'CreateRegistryInput$RegistryName' => 'Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
', 'CreateRegistryResponse$RegistryName' => 'The name of the registry.
', 'CreateSchemaInput$SchemaName' => 'Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
', 'CreateSchemaResponse$RegistryName' => 'The name of the registry.
', 'CreateSchemaResponse$SchemaName' => 'The name of the schema.
', 'DeleteRegistryResponse$RegistryName' => 'The name of the registry being deleted.
', 'DeleteSchemaResponse$SchemaName' => 'The name of the schema being deleted.
', 'GetRegistryResponse$RegistryName' => 'The name of the registry.
', 'GetSchemaResponse$RegistryName' => 'The name of the registry.
', 'GetSchemaResponse$SchemaName' => 'The name of the schema.
', 'PutSchemaVersionMetadataResponse$SchemaName' => 'The name for the schema.
', 'PutSchemaVersionMetadataResponse$RegistryName' => 'The name for the registry.
', 'RegistryId$RegistryName' => 'Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.
The name of the registry.
', 'RemoveSchemaVersionMetadataResponse$SchemaName' => 'The name of the schema.
', 'RemoveSchemaVersionMetadataResponse$RegistryName' => 'The name of the registry.
', 'SchemaId$SchemaName' => 'The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
', 'SchemaListItem$RegistryName' => 'the name of the registry where the schema resides.
', 'SchemaListItem$SchemaName' => 'The name of the schema.
', 'UpdateRegistryResponse$RegistryName' => 'The name of the updated registry.
', 'UpdateSchemaResponse$SchemaName' => 'The name of the schema.
', 'UpdateSchemaResponse$RegistryName' => 'The name of the registry that contains the schema.
', ], ], 'SchemaRegistryTokenString' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListRegistriesResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'ListSchemaVersionsInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListSchemaVersionsResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'ListSchemasInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListSchemasResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'QuerySchemaVersionMetadataInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'QuerySchemaVersionMetadataResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', ], ], 'SchemaStatus' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$SchemaStatus' => 'The status of the schema.
', 'DeleteSchemaResponse$Status' => 'The status of the schema.
', 'GetSchemaResponse$SchemaStatus' => 'The status of the schema.
', 'SchemaListItem$SchemaStatus' => 'The status of the schema.
', ], ], 'SchemaValidationError' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityResponse$Error' => 'A validation failure error message.
', ], ], 'SchemaVersionErrorItem' => [ 'base' => 'An object that contains the error details for an operation on a schema version.
', 'refs' => [ 'SchemaVersionErrorList$member' => NULL, ], ], 'SchemaVersionErrorList' => [ 'base' => NULL, 'refs' => [ 'DeleteSchemaVersionsResponse$SchemaVersionErrors' => 'A list of SchemaVersionErrorItem objects, each containing an error and schema version.
The unique identifier of the first schema version.
', 'GetSchemaByDefinitionResponse$SchemaVersionId' => 'The schema ID of the schema version.
', 'GetSchemaVersionInput$SchemaVersionId' => 'The SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.
The SchemaVersionId of the schema version.
The unique version ID of the schema version.
', 'PutSchemaVersionMetadataResponse$SchemaVersionId' => 'The unique version ID of the schema version.
', 'QuerySchemaVersionMetadataInput$SchemaVersionId' => 'The unique version ID of the schema version.
', 'QuerySchemaVersionMetadataResponse$SchemaVersionId' => 'The unique version ID of the schema version.
', 'RegisterSchemaVersionResponse$SchemaVersionId' => 'The unique ID that represents the version of this schema.
', 'RemoveSchemaVersionMetadataInput$SchemaVersionId' => 'The unique version ID of the schema version.
', 'RemoveSchemaVersionMetadataResponse$SchemaVersionId' => 'The version ID for the schema version.
', 'SchemaReference$SchemaVersionId' => 'The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
The unique identifier of the schema version.
', ], ], 'SchemaVersionList' => [ 'base' => NULL, 'refs' => [ 'ListSchemaVersionsResponse$Schemas' => 'An array of SchemaVersionList objects containing details of each schema version.
An object containing the details about a schema version.
', 'refs' => [ 'SchemaVersionList$member' => NULL, ], ], 'SchemaVersionNumber' => [ 'base' => 'A structure containing the schema version information.
', 'refs' => [ 'GetSchemaVersionInput$SchemaVersionNumber' => 'The version number of the schema.
', 'GetSchemaVersionsDiffInput$FirstSchemaVersionNumber' => 'The first of the two schema versions to be compared.
', 'GetSchemaVersionsDiffInput$SecondSchemaVersionNumber' => 'The second of the two schema versions to be compared.
', 'PutSchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'QuerySchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'RemoveSchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'UpdateSchemaInput$SchemaVersionNumber' => 'Version number required for check pointing. One of VersionNumber or Compatibility has to be provided.
The status of the first schema version created.
', 'GetSchemaByDefinitionResponse$Status' => 'The status of the schema version.
', 'GetSchemaVersionResponse$Status' => 'The status of the schema version.
', 'RegisterSchemaVersionResponse$Status' => 'The status of the schema version.
', 'SchemaVersionListItem$Status' => 'The status of the schema version.
', ], ], 'ScriptLocationString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$ScriptLocation' => 'Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
', ], ], 'SearchPropertyPredicates' => [ 'base' => NULL, 'refs' => [ 'SearchTablesRequest$Filters' => 'A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.
Specifies a security configuration.
', 'refs' => [ 'GetSecurityConfigurationResponse$SecurityConfiguration' => 'The requested security configuration.
', 'SecurityConfigurationList$member' => NULL, ], ], 'SecurityConfigurationList' => [ 'base' => NULL, 'refs' => [ 'GetSecurityConfigurationsResponse$SecurityConfigurations' => 'A list of security configurations.
', ], ], 'SecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'PhysicalConnectionRequirements$SecurityGroupIdList' => 'The security group ID list used by the connection.
', ], ], 'Segment' => [ 'base' => 'Defines a non-overlapping region of a table\'s partitions, allowing multiple requests to be run in parallel.
', 'refs' => [ 'GetPartitionsRequest$Segment' => 'The segment of the table\'s partitions to scan in this request.
', 'GetUnfilteredPartitionsMetadataRequest$Segment' => 'The segment of the table\'s partitions to scan in this request.
', ], ], 'SelectFields' => [ 'base' => 'Specifies a transform that chooses the data property keys that you want to keep.
', 'refs' => [ 'CodeGenConfigurationNode$SelectFields' => 'Specifies a transform that chooses the data property keys that you want to keep.
', ], ], 'SelectFromCollection' => [ 'base' => 'Specifies a transform that chooses one DynamicFrame from a collection of DynamicFrames. The output is the selected DynamicFrame
Specifies a transform that chooses one DynamicFrame from a collection of DynamicFrames. The output is the selected DynamicFrame
Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.
', ], ], 'SerDeInfo' => [ 'base' => 'Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
', 'refs' => [ 'StorageDescriptor$SerdeInfo' => 'The serialization/deserialization (SerDe) information.
', ], ], 'Session' => [ 'base' => 'The period in which a remote Spark runtime environment is running.
', 'refs' => [ 'CreateSessionResponse$Session' => 'Returns the session object in the response.
', 'GetSessionResponse$Session' => 'The session object is returned in the response.
', 'SessionList$member' => NULL, ], ], 'SessionCommand' => [ 'base' => 'The SessionCommand that runs the job.
The SessionCommand that runs the job.
The command object.See SessionCommand.
', ], ], 'SessionIdList' => [ 'base' => NULL, 'refs' => [ 'ListSessionsResponse$Ids' => 'Returns the ID of the session.
', ], ], 'SessionList' => [ 'base' => NULL, 'refs' => [ 'ListSessionsResponse$Sessions' => 'Returns the session object.
', ], ], 'SessionStatus' => [ 'base' => NULL, 'refs' => [ 'Session$Status' => 'The session status.
', ], ], 'SkewedInfo' => [ 'base' => 'Specifies skewed values in a table. Skewed values are those that occur with very high frequency.
', 'refs' => [ 'StorageDescriptor$SkewedInfo' => 'The information about values that appear frequently in a column (skewed values).
', ], ], 'SnowflakeNodeData' => [ 'base' => 'Specifies configuration for Snowflake nodes in Glue Studio.
', 'refs' => [ 'SnowflakeSource$Data' => 'Configuration for the Snowflake data source.
', 'SnowflakeTarget$Data' => 'Specifies the data of the Snowflake target node.
', ], ], 'SnowflakeSource' => [ 'base' => 'Specifies a Snowflake data source.
', 'refs' => [ 'CodeGenConfigurationNode$SnowflakeSource' => 'Specifies a Snowflake data source.
', ], ], 'SnowflakeTarget' => [ 'base' => 'Specifies a Snowflake target.
', 'refs' => [ 'CodeGenConfigurationNode$SnowflakeTarget' => 'Specifies a target that writes to a Snowflake data source.
', ], ], 'Sort' => [ 'base' => NULL, 'refs' => [ 'SortCriterion$Sort' => 'An ascending or descending sort.
', ], ], 'SortCriteria' => [ 'base' => NULL, 'refs' => [ 'SearchTablesRequest$SortCriteria' => 'A list of criteria for sorting the results by a field name, in an ascending or descending order.
', ], ], 'SortCriterion' => [ 'base' => 'Specifies a field to sort by and a sort order.
', 'refs' => [ 'SortCriteria$member' => NULL, ], ], 'SortDirectionType' => [ 'base' => NULL, 'refs' => [ 'TaskRunSortCriteria$SortDirection' => 'The sort direction to be used to sort the list of task runs for the machine learning transform.
', 'TransformSortCriteria$SortDirection' => 'The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
', ], ], 'SourceControlAuthStrategy' => [ 'base' => NULL, 'refs' => [ 'SourceControlDetails$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', 'UpdateJobFromSourceControlRequest$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', 'UpdateSourceControlFromJobRequest$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', ], ], 'SourceControlDetails' => [ 'base' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'refs' => [ 'CreateJobRequest$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'Job$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'JobUpdate$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', ], ], 'SourceControlProvider' => [ 'base' => NULL, 'refs' => [ 'SourceControlDetails$Provider' => 'The provider for the remote repository.
', 'UpdateJobFromSourceControlRequest$Provider' => 'The provider for the remote repository.
', 'UpdateSourceControlFromJobRequest$Provider' => 'The provider for the remote repository.
', ], ], 'SparkConnectorSource' => [ 'base' => 'Specifies a connector to an Apache Spark data source.
', 'refs' => [ 'CodeGenConfigurationNode$SparkConnectorSource' => 'Specifies a connector to an Apache Spark data source.
', ], ], 'SparkConnectorTarget' => [ 'base' => 'Specifies a target that uses an Apache Spark connector.
', 'refs' => [ 'CodeGenConfigurationNode$SparkConnectorTarget' => 'Specifies a target that uses an Apache Spark connector.
', ], ], 'SparkSQL' => [ 'base' => 'Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame.
Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame.
Specifies a transform that writes samples of the data to an Amazon S3 bucket.
', 'refs' => [ 'CodeGenConfigurationNode$Spigot' => 'Specifies a transform that writes samples of the data to an Amazon S3 bucket.
', ], ], 'SplitFields' => [ 'base' => 'Specifies a transform that splits data property keys into two DynamicFrames. The output is a collection of DynamicFrames: one with selected data property keys, and one with the remaining data property keys.
Specifies a transform that splits data property keys into two DynamicFrames. The output is a collection of DynamicFrames: one with selected data property keys, and one with the remaining data property keys.
Represents a single entry in the list of values for SqlAliases.
A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify From as MyDataSource, and Alias as SqlName, then in your SQL you can do:
select * from SqlName
and that gets data from MyDataSource.
', ], ], 'SqlQuery' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorSource$Query' => 'The table or SQL query to get the data from. You can specify either ConnectionTable or query, but not both.
A SQL query that must use Spark SQL syntax and return a single data set.
', ], ], 'StartBlueprintRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartBlueprintRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartExportLabelsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartExportLabelsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartImportLabelsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartImportLabelsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartJobRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartJobRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMLEvaluationTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMLEvaluationTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMLLabelingSetGenerationTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMLLabelingSetGenerationTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartingEventBatchCondition' => [ 'base' => 'The batch condition that started the workflow run. Either the number of events in the batch size arrived, in which case the BatchSize member is non-zero, or the batch window expired, in which case the BatchWindow member is non-zero.
', 'refs' => [ 'WorkflowRun$StartingEventBatchCondition' => 'The batch condition that started the workflow run.
', ], ], 'StartingPosition' => [ 'base' => NULL, 'refs' => [ 'KinesisStreamingSourceOptions$StartingPosition' => 'The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest".
Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
', ], ], 'Statement' => [ 'base' => 'The statement or request for a particular action to occur in a session.
', 'refs' => [ 'GetStatementResponse$Statement' => 'Returns the statement.
', 'StatementList$member' => NULL, ], ], 'StatementList' => [ 'base' => NULL, 'refs' => [ 'ListStatementsResponse$Statements' => 'Returns the list of statements.
', ], ], 'StatementOutput' => [ 'base' => 'The code execution output in JSON format.
', 'refs' => [ 'Statement$Output' => 'The output in JSON.
', ], ], 'StatementOutputData' => [ 'base' => 'The code execution output in JSON format.
', 'refs' => [ 'StatementOutput$Data' => 'The code execution output.
', ], ], 'StatementState' => [ 'base' => NULL, 'refs' => [ 'Statement$State' => 'The state while request is actioned.
', 'StatementOutput$Status' => 'The status of the code execution output.
', ], ], 'StopCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StorageDescriptor' => [ 'base' => 'Describes the physical storage of table data.
', 'refs' => [ 'Partition$StorageDescriptor' => 'Provides information about the physical location where the partition is stored.
', 'PartitionInput$StorageDescriptor' => 'Provides information about the physical location where the partition is stored.
', 'Table$StorageDescriptor' => 'A storage descriptor containing information about the physical storage of this table.
', 'TableInput$StorageDescriptor' => 'A storage descriptor containing information about the physical storage of this table.
', ], ], 'StreamingDataPreviewOptions' => [ 'base' => 'Specifies options related to data preview for viewing a sample of your data.
', 'refs' => [ 'CatalogKafkaSource$DataPreviewOptions' => 'Specifies options related to data preview for viewing a sample of your data.
', 'CatalogKinesisSource$DataPreviewOptions' => 'Additional options for data preview.
', 'DirectKafkaSource$DataPreviewOptions' => 'Specifies options related to data preview for viewing a sample of your data.
', 'DirectKinesisSource$DataPreviewOptions' => 'Additional options for data preview.
', ], ], 'StringColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for character sequence data values.
', 'refs' => [ 'ColumnStatisticsData$StringColumnStatisticsData' => 'String column statistics data.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$SecurityGroupIds' => 'Security group IDs for the security groups to be used by the new DevEndpoint.
The security groups assigned to the new DevEndpoint.
A list of security group identifiers used in this DevEndpoint.
The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint.
Represents a collection of related data organized in columns and rows.
', 'refs' => [ 'GetTableResponse$Table' => 'The Table object that defines the specified table.
A Table object containing the table metadata.
', 'TableList$member' => NULL, 'TableVersion$Table' => 'The table in question.
', ], ], 'TableError' => [ 'base' => 'An error record for table operations.
', 'refs' => [ 'TableErrors$member' => NULL, ], ], 'TableErrors' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableResponse$Errors' => 'A list of errors encountered in attempting to delete the specified tables.
', ], ], 'TableIdentifier' => [ 'base' => 'A structure that describes a target table for resource linking.
', 'refs' => [ 'Table$TargetTable' => 'A TableIdentifier structure that describes a target table for resource linking.
A TableIdentifier structure that describes a target table for resource linking.
A structure used to define a table.
', 'refs' => [ 'CreateTableRequest$TableInput' => 'The TableInput object that defines the metadata table to create in the catalog.
An updated TableInput object to define the metadata table in the catalog.
A list of the requested Table objects.
A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.
The name of the source table.
', 'MappingEntry$TargetTable' => 'The target table.
', ], ], 'TablePrefix' => [ 'base' => NULL, 'refs' => [ 'Crawler$TablePrefix' => 'The prefix added to the names of tables that are created.
', 'CreateCrawlerRequest$TablePrefix' => 'The table prefix used for catalog tables that are created.
', 'UpdateCrawlerRequest$TablePrefix' => 'The table prefix used for catalog tables that are created.
', ], ], 'TableTypeString' => [ 'base' => NULL, 'refs' => [ 'Table$TableType' => 'The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Specifies a version of a table.
', 'refs' => [ 'GetTableVersionResponse$TableVersion' => 'The requested table version.
', 'GetTableVersionsList$member' => NULL, ], ], 'TableVersionError' => [ 'base' => 'An error record for table-version operations.
', 'refs' => [ 'TableVersionErrors$member' => NULL, ], ], 'TableVersionErrors' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionResponse$Errors' => 'A list of errors encountered while trying to delete the specified table versions.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeysList$member' => NULL, 'TagsMap$key' => NULL, ], ], 'TagKeysList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagsToRemove' => 'Tags to remove from this resource.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagsMap$value' => NULL, ], ], 'TagsMap' => [ 'base' => NULL, 'refs' => [ 'CreateBlueprintRequest$Tags' => 'The tags to be applied to this blueprint.
', 'CreateConnectionRequest$Tags' => 'The tags you assign to the connection.
', 'CreateCrawlerRequest$Tags' => 'The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateCustomEntityTypeRequest$Tags' => 'A list of tags applied to the custom entity type.
', 'CreateDataQualityRulesetRequest$Tags' => 'A list of tags applied to the data quality ruleset.
', 'CreateDatabaseRequest$Tags' => 'The tags you assign to the database.
', 'CreateDevEndpointRequest$Tags' => 'The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateJobRequest$Tags' => 'The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateMLTransformRequest$Tags' => 'The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateRegistryInput$Tags' => 'Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
', 'CreateRegistryResponse$Tags' => 'The tags for the registry.
', 'CreateSchemaInput$Tags' => 'Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
', 'CreateSchemaResponse$Tags' => 'The tags for the schema.
', 'CreateSessionRequest$Tags' => 'The map of key value pairs (tags) belonging to the session.
', 'CreateTriggerRequest$Tags' => 'The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateWorkflowRequest$Tags' => 'The tags to be used with this workflow.
', 'GetTagsResponse$Tags' => 'The requested tags.
', 'ListBlueprintsRequest$Tags' => 'Filters the list by an Amazon Web Services resource tag.
', 'ListCrawlersRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListCustomEntityTypesRequest$Tags' => 'A list of key-value pair tags.
', 'ListDataQualityRulesetsRequest$Tags' => 'A list of key-value pair tags.
', 'ListDevEndpointsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListJobsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListMLTransformsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListSessionsRequest$Tags' => 'Tags belonging to the session.
', 'ListTriggersRequest$Tags' => 'Specifies to return only these tagged resources.
', 'TagResourceRequest$TagsToAdd' => 'Tags to add to this resource.
', ], ], 'TargetFormat' => [ 'base' => NULL, 'refs' => [ 'S3DeltaDirectTarget$Format' => 'Specifies the data output format for the target.
', 'S3DirectTarget$Format' => 'Specifies the data output format for the target.
', 'S3HudiDirectTarget$Format' => 'Specifies the data output format for the target.
', ], ], 'TaskRun' => [ 'base' => 'The sampling parameters that are associated with the machine learning transform.
', 'refs' => [ 'TaskRunList$member' => NULL, ], ], 'TaskRunFilterCriteria' => [ 'base' => 'The criteria that are used to filter the task runs for the machine learning transform.
', 'refs' => [ 'GetMLTaskRunsRequest$Filter' => 'The filter criteria, in the TaskRunFilterCriteria structure, for the task run.
A list of task runs that are associated with the transform.
', ], ], 'TaskRunProperties' => [ 'base' => 'The configuration properties for the task run.
', 'refs' => [ 'GetMLTaskRunResponse$Properties' => 'The list of properties that are associated with the task run.
', 'TaskRun$Properties' => 'Specifies configuration properties associated with this task run.
', ], ], 'TaskRunSortColumnType' => [ 'base' => NULL, 'refs' => [ 'TaskRunSortCriteria$Column' => 'The column to be used to sort the list of task runs for the machine learning transform.
', ], ], 'TaskRunSortCriteria' => [ 'base' => 'The sorting criteria that are used to sort the list of task runs for the machine learning transform.
', 'refs' => [ 'GetMLTaskRunsRequest$Sort' => 'The sorting criteria, in the TaskRunSortCriteria structure, for the task run.
The status for this run.
', 'DataQualityRuleRecommendationRunDescription$Status' => 'The status for this run.
', 'DataQualityRulesetEvaluationRunDescription$Status' => 'The status for this run.
', 'GetDataQualityRuleRecommendationRunResponse$Status' => 'The status for this run.
', 'GetDataQualityRulesetEvaluationRunResponse$Status' => 'The status for this run.
', 'GetMLTaskRunResponse$Status' => 'The status for this task run.
', 'TaskRun$Status' => 'The current status of the requested task run.
', 'TaskRunFilterCriteria$Status' => 'The current status of the task run.
', ], ], 'TaskType' => [ 'base' => NULL, 'refs' => [ 'TaskRunFilterCriteria$TaskRunType' => 'The type of task run.
', 'TaskRunProperties$TaskType' => 'The type of task run.
', ], ], 'Timeout' => [ 'base' => NULL, 'refs' => [ 'Action$Timeout' => 'The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the documentation for other job types.
', 'CreateSessionRequest$IdleTimeout' => 'The number of minutes when idle before session times out. Default for Spark ETL jobs is value of Timeout. Consult the documentation for other job types.
', 'GetDataQualityRuleRecommendationRunResponse$Timeout' => 'The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.
Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
', 'JobUpdate$Timeout' => 'The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout in minutes of the machine learning transform.
', 'StartDataQualityRuleRecommendationRunRequest$Timeout' => 'The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.
Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
', 'UpdateMLTransformRequest$Timeout' => 'The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The time that the migration was started.
', 'ColumnStatistics$AnalyzedTime' => 'The timestamp of when column statistics were generated.
', 'Connection$CreationTime' => 'The time that this connection definition was created.
', 'Connection$LastUpdatedTime' => 'The last time that this connection definition was updated.
', 'Crawler$CreationTime' => 'The time that the crawler was created.
', 'Crawler$LastUpdated' => 'The time that the crawler was last updated.
', 'CrawlerHistory$StartTime' => 'The date and time on which the crawl started.
', 'CrawlerHistory$EndTime' => 'The date and time on which the crawl ended.
', 'CsvClassifier$CreationTime' => 'The time that this classifier was registered.
', 'CsvClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'DataQualityResult$StartedOn' => 'The date and time when this data quality run started.
', 'DataQualityResult$CompletedOn' => 'The date and time when this data quality run completed.
', 'DataQualityResultDescription$StartedOn' => 'The time that the run started for this data quality result.
', 'DataQualityResultFilterCriteria$StartedAfter' => 'Filter results by runs that started after this time.
', 'DataQualityResultFilterCriteria$StartedBefore' => 'Filter results by runs that started before this time.
', 'DataQualityRuleRecommendationRunDescription$StartedOn' => 'The date and time when this run started.
', 'DataQualityRuleRecommendationRunFilter$StartedBefore' => 'Filter based on time for results started before provided time.
', 'DataQualityRuleRecommendationRunFilter$StartedAfter' => 'Filter based on time for results started after provided time.
', 'DataQualityRulesetEvaluationRunDescription$StartedOn' => 'The date and time when the run started.
', 'DataQualityRulesetEvaluationRunFilter$StartedBefore' => 'Filter results by runs that started before this time.
', 'DataQualityRulesetEvaluationRunFilter$StartedAfter' => 'Filter results by runs that started after this time.
', 'DataQualityRulesetFilterCriteria$CreatedBefore' => 'Filter on rulesets created before this date.
', 'DataQualityRulesetFilterCriteria$CreatedAfter' => 'Filter on rulesets created after this date.
', 'DataQualityRulesetFilterCriteria$LastModifiedBefore' => 'Filter on rulesets last modified before this date.
', 'DataQualityRulesetFilterCriteria$LastModifiedAfter' => 'Filter on rulesets last modified after this date.
', 'DataQualityRulesetListDetails$CreatedOn' => 'The date and time the data quality ruleset was created.
', 'DataQualityRulesetListDetails$LastModifiedOn' => 'The date and time the data quality ruleset was last modified.
', 'Database$CreateTime' => 'The time at which the metadata database was created in the catalog.
', 'DateColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DateColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', 'GetDataQualityResultResponse$StartedOn' => 'The date and time when the run for this data quality result started.
', 'GetDataQualityResultResponse$CompletedOn' => 'The date and time when the run for this data quality result was completed.
', 'GetDataQualityRuleRecommendationRunResponse$StartedOn' => 'The date and time when this run started.
', 'GetDataQualityRuleRecommendationRunResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality rule recommendation run was modified.
', 'GetDataQualityRuleRecommendationRunResponse$CompletedOn' => 'The date and time when this run was completed.
', 'GetDataQualityRulesetEvaluationRunResponse$StartedOn' => 'The date and time when this run started.
', 'GetDataQualityRulesetEvaluationRunResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality rule recommendation run was modified.
', 'GetDataQualityRulesetEvaluationRunResponse$CompletedOn' => 'The date and time when this run was completed.
', 'GetDataQualityRulesetResponse$CreatedOn' => 'A timestamp. The time and date that this data quality ruleset was created.
', 'GetDataQualityRulesetResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality ruleset was modified.
', 'GetMLTaskRunResponse$StartedOn' => 'The date and time when this task run started.
', 'GetMLTaskRunResponse$LastModifiedOn' => 'The date and time when this task run was last modified.
', 'GetMLTaskRunResponse$CompletedOn' => 'The date and time when this task run was completed.
', 'GetMLTransformResponse$CreatedOn' => 'The date and time when the transform was created.
', 'GetMLTransformResponse$LastModifiedOn' => 'The date and time when the transform was last modified.
', 'GetPartitionsRequest$QueryAsOfTime' => 'The time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
The date and time at which the policy was created.
', 'GetResourcePolicyResponse$UpdateTime' => 'The date and time at which the policy was last updated.
', 'GetTableRequest$QueryAsOfTime' => 'The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
The date and time at which the policy was created.
', 'GluePolicy$UpdateTime' => 'The date and time at which the policy was last updated.
', 'GrokClassifier$CreationTime' => 'The time that this classifier was registered.
', 'GrokClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'JsonClassifier$CreationTime' => 'The time that this classifier was registered.
', 'JsonClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'LastCrawlInfo$StartTime' => 'The time at which the crawl started.
', 'MLTransform$CreatedOn' => 'A timestamp. The time and date that this machine learning transform was created.
', 'MLTransform$LastModifiedOn' => 'A timestamp. The last point in time when this machine learning transform was modified.
', 'Partition$CreationTime' => 'The time at which the partition was created.
', 'Partition$LastAccessTime' => 'The last time at which the partition was accessed.
', 'Partition$LastAnalyzedTime' => 'The last time at which column statistics were computed for this partition.
', 'PartitionInput$LastAccessTime' => 'The last time at which the partition was accessed.
', 'PartitionInput$LastAnalyzedTime' => 'The last time at which column statistics were computed for this partition.
', 'Table$CreateTime' => 'The time when the table definition was created in the Data Catalog.
', 'Table$UpdateTime' => 'The last time that the table was updated.
', 'Table$LastAccessTime' => 'The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
', 'Table$LastAnalyzedTime' => 'The last time that column statistics were computed for this table.
', 'TableInput$LastAccessTime' => 'The last time that the table was accessed.
', 'TableInput$LastAnalyzedTime' => 'The last time that column statistics were computed for this table.
', 'TaskRun$StartedOn' => 'The date and time that this task run started.
', 'TaskRun$LastModifiedOn' => 'The last point in time that the requested task run was updated.
', 'TaskRun$CompletedOn' => 'The last point in time that the requested task run was completed.
', 'TaskRunFilterCriteria$StartedBefore' => 'Filter on task runs started before this date.
', 'TaskRunFilterCriteria$StartedAfter' => 'Filter on task runs started after this date.
', 'TransformFilterCriteria$CreatedBefore' => 'The time and date before which the transforms were created.
', 'TransformFilterCriteria$CreatedAfter' => 'The time and date after which the transforms were created.
', 'TransformFilterCriteria$LastModifiedBefore' => 'Filter on transforms last modified before this date.
', 'TransformFilterCriteria$LastModifiedAfter' => 'Filter on transforms last modified after this date.
', 'UserDefinedFunction$CreateTime' => 'The time at which the function was created.
', 'XMLClassifier$CreationTime' => 'The time that this classifier was registered.
', 'XMLClassifier$LastUpdated' => 'The time that this classifier was last updated.
', ], ], 'TimestampValue' => [ 'base' => NULL, 'refs' => [ 'Blueprint$CreatedOn' => 'The date and time the blueprint was registered.
', 'Blueprint$LastModifiedOn' => 'The date and time the blueprint was last modified.
', 'BlueprintRun$StartedOn' => 'The date and time that the blueprint run started.
', 'BlueprintRun$CompletedOn' => 'The date and time that the blueprint run completed.
', 'Crawl$StartedOn' => 'The date and time on which the crawl started.
', 'Crawl$CompletedOn' => 'The date and time on which the crawl completed.
', 'CreateDevEndpointResponse$CreatedTimestamp' => 'The point in time at which this DevEndpoint was created.
The time at which the new security configuration was created.
', 'DevEndpoint$CreatedTimestamp' => 'The point in time at which this DevEndpoint was created.
', 'DevEndpoint$LastModifiedTimestamp' => 'The point in time at which this DevEndpoint was last modified.
The time and date that this job definition was created.
', 'Job$LastModifiedOn' => 'The last point in time when this job definition was modified.
', 'JobRun$StartedOn' => 'The date and time at which this job run was started.
', 'JobRun$LastModifiedOn' => 'The last time that this job run was modified.
', 'JobRun$CompletedOn' => 'The date and time that this job run completed.
', 'LastActiveDefinition$LastModifiedOn' => 'The date and time the blueprint was last modified.
', 'SecurityConfiguration$CreatedTimeStamp' => 'The time at which this security configuration was created.
', 'Session$CreatedOn' => 'The time and date when the session was created.
', 'Workflow$CreatedOn' => 'The date and time when the workflow was created.
', 'Workflow$LastModifiedOn' => 'The date and time when the workflow was last modified.
', 'WorkflowRun$StartedOn' => 'The date and time when the workflow run was started.
', 'WorkflowRun$CompletedOn' => 'The date and time when the workflow run completed.
', ], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'GetClassifiersRequest$NextToken' => 'An optional continuation token.
', 'GetClassifiersResponse$NextToken' => 'A continuation token.
', 'GetConnectionsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetConnectionsResponse$NextToken' => 'A continuation token, if the list of connections returned does not include the last of the filtered connections.
', 'GetCrawlerMetricsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetCrawlerMetricsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'GetCrawlersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'GetCrawlersResponse$NextToken' => 'A continuation token, if the returned list has not reached the end of those defined in this customer account.
', 'GetDatabasesRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetDatabasesResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'GetPartitionIndexesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'GetPartitionIndexesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', 'GetPartitionsRequest$NextToken' => 'A continuation token, if this is not the first call to retrieve these partitions.
', 'GetPartitionsResponse$NextToken' => 'A continuation token, if the returned list of partitions does not include the last one.
', 'GetResourcePoliciesRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'GetResourcePoliciesResponse$NextToken' => 'A continuation token, if the returned list does not contain the last resource policy available.
', 'GetTableVersionsRequest$NextToken' => 'A continuation token, if this is not the first call.
', 'GetTableVersionsResponse$NextToken' => 'A continuation token, if the list of available versions does not include the last one.
', 'GetTablesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'GetTablesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', 'GetUnfilteredPartitionsMetadataRequest$NextToken' => 'A continuation token, if this is not the first call to retrieve these partitions.
', 'GetUnfilteredPartitionsMetadataResponse$NextToken' => 'A continuation token, if the returned list of partitions does not include the last one.
', 'GetUserDefinedFunctionsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetUserDefinedFunctionsResponse$NextToken' => 'A continuation token, if the list of functions returned does not include the last requested function.
', 'ListCrawlersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListCrawlersResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListCrawlsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListCrawlsResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'SearchTablesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'SearchTablesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', ], ], 'Topk' => [ 'base' => NULL, 'refs' => [ 'Spigot$Topk' => 'Specifies a number of records to write starting from the beginning of the dataset.
', ], ], 'TotalSegmentsInteger' => [ 'base' => NULL, 'refs' => [ 'Segment$TotalSegments' => 'The total number of segments.
', ], ], 'TransactionIdString' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableRequest$TransactionId' => 'The transaction ID at which to delete the table contents.
', 'CreateTableRequest$TransactionId' => 'The ID of the transaction.
', 'DeleteTableRequest$TransactionId' => 'The transaction ID at which to delete the table contents.
', 'GetPartitionsRequest$TransactionId' => 'The transaction ID at which to read the partition contents.
', 'GetTableRequest$TransactionId' => 'The transaction ID at which to read the table contents.
', 'GetTablesRequest$TransactionId' => 'The transaction ID at which to read the table contents.
', 'UpdateTableRequest$TransactionId' => 'The transaction ID at which to update the table contents.
', ], ], 'TransformConfigParameter' => [ 'base' => 'Specifies the parameters in the config file of the dynamic transform.
', 'refs' => [ 'TransformConfigParameterList$member' => NULL, ], ], 'TransformConfigParameterList' => [ 'base' => NULL, 'refs' => [ 'DynamicTransform$Parameters' => 'Specifies the parameters of the dynamic transform.
', ], ], 'TransformEncryption' => [ 'base' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.
', 'refs' => [ 'CreateMLTransformRequest$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', 'GetMLTransformResponse$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', 'MLTransform$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', ], ], 'TransformFilterCriteria' => [ 'base' => 'The criteria used to filter the machine learning transforms.
', 'refs' => [ 'GetMLTransformsRequest$Filter' => 'The filter transformation criteria.
', 'ListMLTransformsRequest$Filter' => 'A TransformFilterCriteria used to filter the machine learning transforms.
The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.
', ], ], 'TransformList' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformsResponse$Transforms' => 'A list of machine learning transforms.
', ], ], 'TransformParameters' => [ 'base' => 'The algorithm-specific parameters that are associated with the machine learning transform.
', 'refs' => [ 'CreateMLTransformRequest$Parameters' => 'The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
', 'GetMLTransformResponse$Parameters' => 'The configuration parameters that are specific to the algorithm used.
', 'MLTransform$Parameters' => 'A TransformParameters object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.
', ], ], 'TransformSchema' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformResponse$Schema' => 'The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.
A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
', 'TransformFilterCriteria$Schema' => 'Filters on datasets with a specific schema. The Map<Column, Type> object is an array of key-value pairs representing the schema this transform accepts, where Column is the name of a column, and Type is the type of the data such as an integer or string. Has an upper bound of 100 columns.
The column to be used in the sorting criteria that are associated with the machine learning transform.
', ], ], 'TransformSortCriteria' => [ 'base' => 'The sorting criteria that are associated with the machine learning transform.
', 'refs' => [ 'GetMLTransformsRequest$Sort' => 'The sorting criteria.
', 'ListMLTransformsRequest$Sort' => 'A TransformSortCriteria used to sort the machine learning transforms.
The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
', 'MLTransform$Status' => 'The current status of the machine learning transform.
', 'TransformFilterCriteria$Status' => 'Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
', ], ], 'TransformType' => [ 'base' => NULL, 'refs' => [ 'EvaluationMetrics$TransformType' => 'The type of machine learning transform.
', 'TransformFilterCriteria$TransformType' => 'The type of machine learning transform that is used to filter the machine learning transforms.
', 'TransformParameters$TransformType' => 'The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
', ], ], 'Trigger' => [ 'base' => 'Information about a specific trigger.
', 'refs' => [ 'GetTriggerResponse$Trigger' => 'The requested trigger definition.
', 'TriggerList$member' => NULL, 'TriggerNodeDetails$Trigger' => 'The information of the trigger represented by the trigger node.
', 'UpdateTriggerResponse$Trigger' => 'The resulting trigger definition.
', ], ], 'TriggerList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTriggersResponse$Triggers' => 'A list of trigger definitions.
', 'GetTriggersResponse$Triggers' => 'A list of triggers for the specified job.
', ], ], 'TriggerNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTriggersRequest$TriggerNames' => 'A list of trigger names, which may be the names returned from the ListTriggers operation.
A list of names of triggers not found.
', 'ListTriggersResponse$TriggerNames' => 'The names of all triggers in the account, or the triggers with the specified tags.
', ], ], 'TriggerNodeDetails' => [ 'base' => 'The details of a Trigger node present in the workflow.
', 'refs' => [ 'Node$TriggerDetails' => 'Details of the Trigger when the node represents a Trigger.
', ], ], 'TriggerState' => [ 'base' => NULL, 'refs' => [ 'Trigger$State' => 'The current state of the trigger.
', ], ], 'TriggerType' => [ 'base' => NULL, 'refs' => [ 'CreateTriggerRequest$Type' => 'The type of the new trigger.
', 'Trigger$Type' => 'The type of trigger that this is.
', ], ], 'TriggerUpdate' => [ 'base' => 'A structure used to provide information used to update a trigger. This object updates the previous trigger definition by overwriting it completely.
', 'refs' => [ 'UpdateTriggerRequest$TriggerUpdate' => 'The new values with which to update the trigger.
', ], ], 'TwoInputs' => [ 'base' => NULL, 'refs' => [ 'Join$Inputs' => 'The data inputs identified by their node names.
', 'Merge$Inputs' => 'The data inputs identified by their node names.
', 'Union$Inputs' => 'The node ID inputs to the transform.
', ], ], 'TypeString' => [ 'base' => NULL, 'refs' => [ 'ColumnStatistics$ColumnType' => 'The data type of the column.
', ], ], 'URI' => [ 'base' => NULL, 'refs' => [ 'Database$LocationUri' => 'The location of the database (for example, an HDFS path).
', 'DatabaseInput$LocationUri' => 'The location of the database (for example, an HDFS path).
', 'ResourceUri$Uri' => 'The URI for accessing the resource.
', ], ], 'UnfilteredPartition' => [ 'base' => 'A partition that contains unfiltered metadata.
', 'refs' => [ 'UnfilteredPartitionList$member' => NULL, ], ], 'UnfilteredPartitionList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredPartitionsMetadataResponse$UnfilteredPartitions' => 'A list of requested partitions.
', ], ], 'Union' => [ 'base' => 'Specifies a transform that combines the rows from two or more datasets into a single result.
', 'refs' => [ 'CodeGenConfigurationNode$Union' => 'Specifies a transform that combines the rows from two or more datasets into a single result.
', ], ], 'UnionType' => [ 'base' => NULL, 'refs' => [ 'Union$UnionType' => 'Indicates the type of Union transform.
Specify ALL to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.
Specify DISTINCT to remove duplicate rows in the resulting DynamicFrame.
The update behavior when the crawler finds a changed schema.
', ], ], 'UpdateBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCatalogBehavior' => [ 'base' => NULL, 'refs' => [ 'CatalogSchemaChangePolicy$UpdateBehavior' => 'The update behavior when the crawler finds a changed schema.
', 'DirectSchemaChangePolicy$UpdateBehavior' => 'The update behavior when the crawler finds a changed schema.
', ], ], 'UpdateClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsList' => [ 'base' => NULL, 'refs' => [ 'UpdateColumnStatisticsForPartitionRequest$ColumnStatisticsList' => 'A list of the column statistics.
', 'UpdateColumnStatisticsForTableRequest$ColumnStatisticsList' => 'A list of the column statistics.
', ], ], 'UpdateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCsvClassifierRequest' => [ 'base' => 'Specifies a custom CSV classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$CsvClassifier' => 'A CsvClassifier object with updated fields.
Specifies a grok classifier to update when passed to UpdateClassifier.
A GrokClassifier object with updated fields.
Specifies a JSON classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$JsonClassifier' => 'A JsonClassifier object with updated fields.
Specifies an XML classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$XMLClassifier' => 'An XMLClassifier object with updated fields.
The date and time the registry was updated.
', 'GetSchemaResponse$UpdatedTime' => 'The date and time the schema was updated.
', 'RegistryListItem$UpdatedTime' => 'The date the registry was updated.
', 'SchemaListItem$UpdatedTime' => 'The date and time that a schema was updated.
', ], ], 'UpsertRedshiftTargetOptions' => [ 'base' => 'The options to configure an upsert operation when writing to a Redshift target .
', 'refs' => [ 'RedshiftTarget$UpsertRedshiftOptions' => 'The set of options to configure an upsert operation when writing to a Redshift target.
', ], ], 'UriString' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$LogUri' => 'This field is reserved for future use.
', 'DataQualityEvaluationRunAdditionalRunOptions$ResultsS3Prefix' => 'Prefix for Amazon S3 to store results.
', 'ExportLabelsTaskRunProperties$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
', 'ImportLabelsTaskRunProperties$InputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
', 'Job$LogUri' => 'This field is reserved for future use.
', 'JobUpdate$LogUri' => 'This field is reserved for future use.
', 'LabelingSetGenerationTaskRunProperties$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
', 'StartExportLabelsTaskRunRequest$OutputS3Path' => 'The Amazon S3 path where you export the labels.
', 'StartImportLabelsTaskRunRequest$InputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.
', 'StartMLLabelingSetGenerationTaskRunRequest$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.
', ], ], 'UserDefinedFunction' => [ 'base' => 'Represents the equivalent of a Hive user-defined function (UDF) definition.
The requested function definition.
', 'UserDefinedFunctionList$member' => NULL, ], ], 'UserDefinedFunctionInput' => [ 'base' => 'A structure used to create or update a user-defined function.
', 'refs' => [ 'CreateUserDefinedFunctionRequest$FunctionInput' => 'A FunctionInput object that defines the function to create in the Data Catalog.
A FunctionInput object that redefines the function in the Data Catalog.
A list of requested function definitions.
', ], ], 'ValidationException' => [ 'base' => 'A value could not be validated.
', 'refs' => [], ], 'ValueString' => [ 'base' => NULL, 'refs' => [ 'BoundedPartitionValueList$member' => NULL, 'ConnectionProperties$value' => NULL, 'PropertyPredicate$Key' => 'The key of the property.
', 'PropertyPredicate$Value' => 'The value of the property.
', 'SearchTablesRequest$SearchText' => 'A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
', 'SortCriterion$FieldName' => 'The name of the field on which to sort.
', 'ValueStringList$member' => NULL, ], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'DeleteColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', 'DeletePartitionRequest$PartitionValues' => 'The values that define the partition.
', 'GetColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', 'GetPartitionRequest$PartitionValues' => 'The values that define the partition.
', 'GetUnfilteredPartitionMetadataRequest$PartitionValues' => '(Required) A list of partition key values.
', 'Partition$Values' => 'The values of the partition.
', 'PartitionError$PartitionValues' => 'The values that define the partition.
', 'PartitionInput$Values' => 'The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
', 'PartitionValueList$Values' => 'The list of values.
', 'UpdateColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', ], ], 'VersionId' => [ 'base' => NULL, 'refs' => [ 'Crawler$Version' => 'The version of the crawler.
', 'CsvClassifier$Version' => 'The version of this classifier.
', 'GrokClassifier$Version' => 'The version of this classifier.
', 'JsonClassifier$Version' => 'The version of this classifier.
', 'XMLClassifier$Version' => 'The version of this classifier.
', ], ], 'VersionLongNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$LatestSchemaVersion' => 'The latest version of the schema associated with the returned schema definition.
', 'CreateSchemaResponse$NextSchemaVersion' => 'The next version of the schema associated with the returned schema definition.
', 'GetSchemaResponse$LatestSchemaVersion' => 'The latest version of the schema associated with the returned schema definition.
', 'GetSchemaResponse$NextSchemaVersion' => 'The next version of the schema associated with the returned schema definition.
', 'GetSchemaVersionResponse$VersionNumber' => 'The version number of the schema.
', 'PutSchemaVersionMetadataResponse$VersionNumber' => 'The version number of the schema.
', 'RegisterSchemaVersionResponse$VersionNumber' => 'The version of this schema (for sync flow only, in case this is the first version).
', 'RemoveSchemaVersionMetadataResponse$VersionNumber' => 'The version number of the schema.
', 'SchemaReference$SchemaVersionNumber' => 'The version number of the schema.
', 'SchemaVersionErrorItem$VersionNumber' => 'The version number of the schema.
', 'SchemaVersionListItem$VersionNumber' => 'The version number of the schema.
', 'SchemaVersionNumber$VersionNumber' => 'The version number of the schema.
', ], ], 'VersionMismatchException' => [ 'base' => 'There was a version conflict.
', 'refs' => [], ], 'VersionString' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionList$member' => NULL, 'DeleteTableVersionRequest$VersionId' => 'The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.
The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1.
The table version for the Iceberg table. Defaults to 2.
', 'Table$VersionId' => 'The ID of the table version.
', 'TableVersion$VersionId' => 'The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.
The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.
The version ID at which to update the table contents.
', ], ], 'VersionsString' => [ 'base' => NULL, 'refs' => [ 'DeleteSchemaVersionsInput$Versions' => 'A version range may be supplied which may be of the format:
a single version number, 5
a range, 5-8 : deletes versions 5, 6, 7, 8
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'TableInput$ViewOriginalText' => 'Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', ], ], 'WorkerType' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$WorkerType' => 'The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.
', 'CreateJobRequest$WorkerType' => 'The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
A workflow is a collection of multiple dependent Glue jobs and crawlers that are run to complete a complex ETL task. A workflow manages the execution and monitoring of all its jobs and crawlers.
', 'refs' => [ 'GetWorkflowResponse$Workflow' => 'The resource metadata for the workflow.
', 'Workflows$member' => NULL, ], ], 'WorkflowGraph' => [ 'base' => 'A workflow graph represents the complete workflow containing all the Glue components present in the workflow and all the directed connections between them.
', 'refs' => [ 'Workflow$Graph' => 'The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
', 'WorkflowRun$Graph' => 'The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
', ], ], 'WorkflowNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetWorkflowsRequest$Names' => 'A list of workflow names, which may be the names returned from the ListWorkflows operation.
A list of names of workflows not found.
', 'ListWorkflowsResponse$Workflows' => 'List of names of workflows in the account.
', ], ], 'WorkflowRun' => [ 'base' => 'A workflow run is an execution of a workflow providing all the runtime information.
', 'refs' => [ 'GetWorkflowRunResponse$Run' => 'The requested workflow run metadata.
', 'Workflow$LastRun' => 'The information about the last execution of the workflow.
', 'WorkflowRuns$member' => NULL, ], ], 'WorkflowRunProperties' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow.
', 'GetWorkflowRunPropertiesResponse$RunProperties' => 'The workflow run properties which were set during the specified run.
', 'PutWorkflowRunPropertiesRequest$RunProperties' => 'The properties to put for the specified run.
', 'StartWorkflowRunRequest$RunProperties' => 'The workflow run properties for the new workflow run.
', 'UpdateWorkflowRequest$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow.
', 'Workflow$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
', 'WorkflowRun$WorkflowRunProperties' => 'The workflow run properties which were set during the run.
', ], ], 'WorkflowRunStatistics' => [ 'base' => 'Workflow run statistics provides statistics about the workflow run.
', 'refs' => [ 'WorkflowRun$Statistics' => 'The statistics of the run.
', ], ], 'WorkflowRunStatus' => [ 'base' => NULL, 'refs' => [ 'WorkflowRun$Status' => 'The status of the workflow run.
', ], ], 'WorkflowRuns' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowRunsResponse$Runs' => 'A list of workflow run metadata objects.
', ], ], 'Workflows' => [ 'base' => NULL, 'refs' => [ 'BatchGetWorkflowsResponse$Workflows' => 'A list of workflow resource metadata.
', ], ], 'XMLClassifier' => [ 'base' => 'A classifier for XML content.
A classifier for XML content.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Defines the public endpoint for the Glue service.
', 'operations' => [ 'BatchCreatePartition' => 'Creates one or more partitions in a batch operation.
', 'BatchDeleteConnection' => 'Deletes a list of connection definitions from the Data Catalog.
', 'BatchDeletePartition' => 'Deletes one or more partitions in a batch operation.
', 'BatchDeleteTable' => 'Deletes multiple tables at once.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.
Deletes a specified batch of versions of a table.
', 'BatchGetBlueprints' => 'Retrieves information about a list of blueprints.
', 'BatchGetCrawlers' => 'Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves the details for the custom patterns specified by a list of names.
', 'BatchGetDataQualityResult' => 'Retrieves a list of data quality results for the specified result IDs.
', 'BatchGetDevEndpoints' => 'Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves partitions in a batch request.
', 'BatchGetTriggers' => 'Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Stops one or more job runs for a specified job definition.
', 'BatchUpdatePartition' => 'Updates one or more partitions in a batch operation.
', 'CancelDataQualityRuleRecommendationRun' => 'Cancels the specified recommendation run that was being used to generate rules.
', 'CancelDataQualityRulesetEvaluationRun' => 'Cancels a run where a ruleset is being evaluated against a data source.
', 'CancelMLTaskRun' => 'Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling CancelMLTaskRun with a task run\'s parent transform\'s TransformID and the task run\'s TaskRunId.
Cancels the statement.
', 'CheckSchemaVersionValidity' => 'Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat as the format. Since it does not take a schema set name, no compatibility checks are performed.
Registers a blueprint with Glue.
', 'CreateClassifier' => 'Creates a classifier in the user\'s account. This can be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present.
Creates a connection definition in the Data Catalog.
', 'CreateCrawler' => 'Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.
', 'CreateDataQualityRuleset' => 'Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.
', 'CreateDatabase' => 'Creates a new database in a Data Catalog.
', 'CreateDevEndpoint' => 'Creates a new development endpoint.
', 'CreateJob' => 'Creates a new job definition.
', 'CreateMLTransform' => 'Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.
Call this operation as the first step in the process of using a machine learning transform (such as the FindMatches transform) for deduplicating data. You can provide an optional Description, in addition to the parameters that you want to use for your algorithm.
You must also specify certain parameters for the tasks that Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include Role, and optionally, AllocatedCapacity, Timeout, and MaxRetries. For more information, see Jobs.
Creates a new partition.
', 'CreatePartitionIndex' => 'Creates a specified partition index in an existing table.
', 'CreateRegistry' => 'Creates a new registry which may be used to hold a collection of schemas.
', 'CreateSchema' => 'Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.
When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion API is used.
When this API is called without a RegistryId, this will create an entry for a "default-registry" in the registry database tables, if it is not already present.
Transforms a directed acyclic graph (DAG) into code.
', 'CreateSecurityConfiguration' => 'Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.
', 'CreateSession' => 'Creates a new session.
', 'CreateTable' => 'Creates a new table definition in the Data Catalog.
', 'CreateTrigger' => 'Creates a new trigger.
', 'CreateUserDefinedFunction' => 'Creates a new function definition in the Data Catalog.
', 'CreateWorkflow' => 'Creates a new workflow.
', 'DeleteBlueprint' => 'Deletes an existing blueprint.
', 'DeleteClassifier' => 'Removes a classifier from the Data Catalog.
', 'DeleteColumnStatisticsForPartition' => 'Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is DeletePartition.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is DeleteTable.
Deletes a connection from the Data Catalog.
', 'DeleteCrawler' => 'Removes a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING.
Deletes a custom pattern by specifying its name.
', 'DeleteDataQualityRuleset' => 'Deletes a data quality ruleset.
', 'DeleteDatabase' => 'Removes a specified database from a Data Catalog.
After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database.
Deletes a specified development endpoint.
', 'DeleteJob' => 'Deletes a specified job definition. If the job definition is not found, no exception is thrown.
', 'DeleteMLTransform' => 'Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms. However, any Glue jobs that still reference the deleted transform will no longer succeed.
Deletes a specified partition.
', 'DeletePartitionIndex' => 'Deletes a specified partition index from an existing table.
', 'DeleteRegistry' => 'Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.
Deletes a specified policy.
', 'DeleteSchema' => 'Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.
Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions.
When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API.
You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database.
If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.
', 'DeleteSecurityConfiguration' => 'Deletes a specified security configuration.
', 'DeleteSession' => 'Deletes the session.
', 'DeleteTable' => 'Removes a table definition from the Data Catalog.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.
Deletes a specified version of a table.
', 'DeleteTrigger' => 'Deletes a specified trigger. If the trigger is not found, no exception is thrown.
', 'DeleteUserDefinedFunction' => 'Deletes an existing function definition from the Data Catalog.
', 'DeleteWorkflow' => 'Deletes a workflow.
', 'GetBlueprint' => 'Retrieves the details of a blueprint.
', 'GetBlueprintRun' => 'Retrieves the details of a blueprint run.
', 'GetBlueprintRuns' => 'Retrieves the details of blueprint runs for a specified blueprint.
', 'GetCatalogImportStatus' => 'Retrieves the status of a migration operation.
', 'GetClassifier' => 'Retrieve a classifier by name.
', 'GetClassifiers' => 'Lists all classifier objects in the Data Catalog.
', 'GetColumnStatisticsForPartition' => 'Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetPartition.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetTable.
Retrieves a connection definition from the Data Catalog.
', 'GetConnections' => 'Retrieves a list of connection definitions from the Data Catalog.
', 'GetCrawler' => 'Retrieves metadata for a specified crawler.
', 'GetCrawlerMetrics' => 'Retrieves metrics about specified crawlers.
', 'GetCrawlers' => 'Retrieves metadata for all crawlers defined in the customer account.
', 'GetCustomEntityType' => 'Retrieves the details of a custom pattern by specifying its name.
', 'GetDataCatalogEncryptionSettings' => 'Retrieves the security configuration for a specified catalog.
', 'GetDataQualityResult' => 'Retrieves the result of a data quality rule evaluation.
', 'GetDataQualityRuleRecommendationRun' => 'Gets the specified recommendation run that was used to generate rules.
', 'GetDataQualityRuleset' => 'Returns an existing ruleset by identifier or name.
', 'GetDataQualityRulesetEvaluationRun' => 'Retrieves a specific run where a ruleset is evaluated against a data source.
', 'GetDatabase' => 'Retrieves the definition of a specified database.
', 'GetDatabases' => 'Retrieves all databases defined in a given Data Catalog.
', 'GetDataflowGraph' => 'Transforms a Python script into a directed acyclic graph (DAG).
', 'GetDevEndpoint' => 'Retrieves information about a specified development endpoint.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Retrieves all the development endpoints in this Amazon Web Services account.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Retrieves an existing job definition.
', 'GetJobBookmark' => 'Returns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
', 'GetJobRun' => 'Retrieves the metadata for a given job run.
', 'GetJobRuns' => 'Retrieves metadata for all runs of a given job definition.
', 'GetJobs' => 'Retrieves all current job definitions.
', 'GetMLTaskRun' => 'Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling GetMLTaskRun with the TaskRunID and its parent transform\'s TransformID.
Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform\'s TransformID and other optional parameters as documented in this section.
This operation returns a list of historic runs and must be paginated.
', 'GetMLTransform' => 'Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling GetMLTransform.
Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling GetMLTransforms.
Creates mappings.
', 'GetPartition' => 'Retrieves information about a specified partition.
', 'GetPartitionIndexes' => 'Retrieves the partition indexes associated with a table.
', 'GetPartitions' => 'Retrieves information about the partitions in a table.
', 'GetPlan' => 'Gets code to perform a specified mapping.
', 'GetRegistry' => 'Describes the specified registry in detail.
', 'GetResourcePolicies' => 'Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy.
If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can\'t return the Data Catalog resource policy.
', 'GetResourcePolicy' => 'Retrieves a specified resource policy.
', 'GetSchema' => 'Describes the specified schema in detail.
', 'GetSchemaByDefinition' => 'Retrieves a schema by the SchemaDefinition. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of the SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted statuses will not be included in the results.
Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.
', 'GetSchemaVersionsDiff' => 'Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.
', 'GetSecurityConfiguration' => 'Retrieves a specified security configuration.
', 'GetSecurityConfigurations' => 'Retrieves a list of all security configurations.
', 'GetSession' => 'Retrieves the session.
', 'GetStatement' => 'Retrieves the statement.
', 'GetTable' => 'Retrieves the Table definition in a Data Catalog for a specified table.
Retrieves a specified version of a table.
', 'GetTableVersions' => 'Retrieves a list of strings that identify available versions of a specified table.
', 'GetTables' => 'Retrieves the definitions of some or all of the tables in a given Database.
Retrieves a list of tags associated with a resource.
', 'GetTrigger' => 'Retrieves the definition of a trigger.
', 'GetTriggers' => 'Gets all the triggers associated with a job.
', 'GetUnfilteredPartitionMetadata' => 'Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetPartition.
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetPartitions.
Retrieves table metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetTable.
Retrieves a specified function definition from the Data Catalog.
', 'GetUserDefinedFunctions' => 'Retrieves multiple function definitions from the Data Catalog.
', 'GetWorkflow' => 'Retrieves resource metadata for a workflow.
', 'GetWorkflowRun' => 'Retrieves the metadata for a given workflow run.
', 'GetWorkflowRunProperties' => 'Retrieves the workflow run properties which were set during the run.
', 'GetWorkflowRuns' => 'Retrieves metadata for all runs of a given workflow.
', 'ImportCatalogToGlue' => 'Imports an existing Amazon Athena Data Catalog to Glue.
', 'ListBlueprints' => 'Lists all the blueprint names in an account.
', 'ListCrawlers' => 'Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.
You may use this API to:
Retrive all the crawls of a specified crawler.
Retrieve all the crawls of a specified crawler within a limited count.
Retrieve all the crawls of a specified crawler in a specific time range.
Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.
Lists all the custom patterns that have been created.
', 'ListDataQualityResults' => 'Returns all data quality execution results for your account.
', 'ListDataQualityRuleRecommendationRuns' => 'Lists the recommendation runs meeting the filter criteria.
', 'ListDataQualityRulesetEvaluationRuns' => 'Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
', 'ListDataQualityRulesets' => 'Returns a paginated list of rulesets for the specified list of Glue tables.
', 'ListDevEndpoints' => 'Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.
Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available.
Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.
', 'ListSchemas' => 'Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.
When the RegistryId is not provided, all the schemas across registries will be part of the API response.
Retrieve a list of sessions.
', 'ListStatements' => 'Lists statements for the session.
', 'ListTriggers' => 'Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Lists names of workflows created in the account.
', 'PutDataCatalogEncryptionSettings' => 'Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.
', 'PutResourcePolicy' => 'Sets the Data Catalog resource policy for access control.
', 'PutSchemaVersionMetadata' => 'Puts the metadata key value pair for a specified schema version ID. A maximum of 10 key value pairs will be allowed per schema version. They can be added over one or more calls.
', 'PutWorkflowRunProperties' => 'Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.
', 'QuerySchemaVersionMetadata' => 'Queries for the schema version metadata information.
', 'RegisterSchemaVersion' => 'Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.
If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.
If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.
', 'RemoveSchemaVersionMetadata' => 'Removes a key value pair from the schema version metadata for the specified schema version ID.
', 'ResetJobBookmark' => 'Resets a bookmark entry.
For more information about enabling and using job bookmarks, see:
', 'ResumeWorkflowRun' => 'Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run.
', 'RunStatement' => 'Executes the statement.
', 'SearchTables' => 'Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.
', 'StartBlueprintRun' => 'Starts a new run of the specified blueprint.
', 'StartCrawler' => 'Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException.
', 'StartCrawlerSchedule' => 'Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED.
Starts a recommendation run that is used to generate rules when you don\'t know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.
', 'StartDataQualityRulesetEvaluationRun' => 'Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table). The evaluation computes results which you can retrieve with the GetDataQualityResult API.
Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning workflow. You typically use StartExportLabelsTaskRun when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts the TransformId whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a TaskRunId. You can check on the status of your task run by calling the GetMLTaskRun API.
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the quality of your machine learning transform.
After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called \'labeling\' in the machine learning workflows). In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.
By default, StartMLLabelingSetGenerationTaskRun continually learns from and combines all labels that you upload unless you set Replace to true. If you set Replace to true, StartImportLabelsTaskRun deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality.
You can check on the status of your task run by calling the GetMLTaskRun operation.
Starts a job run using a job definition.
', 'StartMLEvaluationTaskRun' => 'Starts a task to estimate the quality of the transform.
When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.
Returns a unique identifier for the run. You can call GetMLTaskRun to get more information about the stats of the EvaluationTaskRun.
Starts the active learning workflow for your machine learning transform to improve the transform\'s quality by generating label sets and adding labels.
When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.
In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”
After the labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.
Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.
', 'StartWorkflowRun' => 'Starts a new run of the specified workflow.
', 'StopCrawler' => 'If the specified crawler is running, stops the crawl.
', 'StopCrawlerSchedule' => 'Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running.
Stops the session.
', 'StopTrigger' => 'Stops a specified trigger.
', 'StopWorkflowRun' => 'Stops the execution of the specified workflow run.
', 'TagResource' => 'Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource. In Glue, you can tag only certain resources. For information about what resources you can tag, see Amazon Web Services Tags in Glue.
', 'UntagResource' => 'Removes tags from a resource.
', 'UpdateBlueprint' => 'Updates a registered blueprint.
', 'UpdateClassifier' => 'Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).
Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdateTable.
Updates a connection definition in the Data Catalog.
', 'UpdateCrawler' => 'Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.
Updates the schedule of a crawler using a cron expression.
Updates the specified data quality ruleset.
', 'UpdateDatabase' => 'Updates an existing database definition in a Data Catalog.
', 'UpdateDevEndpoint' => 'Updates a specified development endpoint.
', 'UpdateJob' => 'Updates an existing job definition. The previous job definition is completely overwritten by this information.
', 'UpdateJobFromSourceControl' => 'Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.
This API supports optional parameters which take in the repository information.
', 'UpdateMLTransform' => 'Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.
After calling this operation, you can call the StartMLEvaluationTaskRun operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).
Updates a partition.
', 'UpdateRegistry' => 'Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry.
', 'UpdateSchema' => 'Updates the description, compatibility setting, or version checkpoint for a schema set.
For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.
If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema.
This update will happen only if the schema is in the AVAILABLE state.
', 'UpdateSourceControlFromJob' => 'Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job.
This API supports optional parameters which take in the repository information.
', 'UpdateTable' => 'Updates a metadata table in the Data Catalog.
', 'UpdateTrigger' => 'Updates a trigger definition.
', 'UpdateUserDefinedFunction' => 'Updates an existing function definition in the Data Catalog.
', 'UpdateWorkflow' => 'Updates an existing workflow.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'Access to a resource was denied.
', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'LakeFormationConfiguration$AccountId' => 'Required for cross account crawls. For same account crawls as the target data, this can be left as null.
', ], ], 'Action' => [ 'base' => 'Defines an action to be initiated by a trigger.
', 'refs' => [ 'ActionList$member' => NULL, ], ], 'ActionList' => [ 'base' => NULL, 'refs' => [ 'CreateTriggerRequest$Actions' => 'The actions initiated by this trigger when it fires.
', 'Trigger$Actions' => 'The actions initiated by this trigger.
', 'TriggerUpdate$Actions' => 'The actions initiated by this trigger.
', ], ], 'AdditionalOptionKeys' => [ 'base' => NULL, 'refs' => [ 'DQAdditionalOptions$key' => NULL, ], ], 'AdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'CatalogDeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'CatalogHudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'JDBCConnectorTarget$AdditionalOptions' => 'Additional connection options for the connector.
', 'S3CatalogDeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'S3CatalogHudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'S3DeltaCatalogTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3DeltaDirectTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3DeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'S3HudiCatalogTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3HudiDirectTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3HudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'SnowflakeNodeData$AdditionalOptions' => 'Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
', 'SparkConnectorSource$AdditionalOptions' => 'Additional connection options for the connector.
', 'SparkConnectorTarget$AdditionalOptions' => 'Additional connection options for the connector.
', ], ], 'AdditionalPlanOptionsMap' => [ 'base' => NULL, 'refs' => [ 'GetPlanRequest$AdditionalPlanOptionsMap' => 'A map to hold additional optional key-value parameters.
Currently, these key-value pairs are supported:
inferSchema — Specifies whether to set inferSchema to true or false for the default script generated by an Glue job. For example, to set inferSchema to true, pass the following key value pair:
--additional-plan-options-map \'{"inferSchema":"true"}\'
Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
', ], ], 'Aggregate' => [ 'base' => 'Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
', 'refs' => [ 'CodeGenConfigurationNode$Aggregate' => 'Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
', ], ], 'AggregateOperation' => [ 'base' => 'Specifies the set of parameters needed to perform aggregation in the aggregate transform.
', 'refs' => [ 'AggregateOperations$member' => NULL, ], ], 'AggregateOperations' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Aggs' => 'Specifies the aggregate functions to be performed on specified fields.
', ], ], 'AlreadyExistsException' => [ 'base' => 'A resource to be created or added already exists.
', 'refs' => [], ], 'AmazonRedshiftAdvancedOption' => [ 'base' => 'Specifies an optional value when connecting to the Redshift cluster.
', 'refs' => [ 'AmazonRedshiftAdvancedOptions$member' => NULL, ], ], 'AmazonRedshiftAdvancedOptions' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$AdvancedOptions' => 'Optional values when connecting to the Redshift cluster.
', ], ], 'AmazonRedshiftNodeData' => [ 'base' => 'Specifies an Amazon Redshift node.
', 'refs' => [ 'AmazonRedshiftSource$Data' => 'Specifies the data of the Amazon Reshift source node.
', 'AmazonRedshiftTarget$Data' => 'Specifies the data of the Amazon Redshift target node.
', ], ], 'AmazonRedshiftSource' => [ 'base' => 'Specifies an Amazon Redshift source.
', 'refs' => [ 'CodeGenConfigurationNode$AmazonRedshiftSource' => 'Specifies a target that writes to a data source in Amazon Redshift.
', ], ], 'AmazonRedshiftTarget' => [ 'base' => 'Specifies an Amazon Redshift target.
', 'refs' => [ 'CodeGenConfigurationNode$AmazonRedshiftTarget' => 'Specifies a target that writes to a data target in Amazon Redshift.
', ], ], 'ApplyMapping' => [ 'base' => 'Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
', 'refs' => [ 'CodeGenConfigurationNode$ApplyMapping' => 'Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
', ], ], 'AthenaConnectorSource' => [ 'base' => 'Specifies a connector to an Amazon Athena data source.
', 'refs' => [ 'CodeGenConfigurationNode$AthenaConnectorSource' => 'Specifies a connector to an Amazon Athena data source.
', ], ], 'AttemptCount' => [ 'base' => NULL, 'refs' => [ 'JobRun$Attempt' => 'The number of the attempt to run this job.
', ], ], 'AuditColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'AuditContext$RequestedColumns' => 'The requested columns for audit.
', ], ], 'AuditContext' => [ 'base' => 'A structure containing the Lake Formation audit context.
', 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', 'GetUnfilteredPartitionsMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', 'GetUnfilteredTableMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', ], ], 'AuditContextString' => [ 'base' => NULL, 'refs' => [ 'AuditContext$AdditionalAuditContext' => 'A string containing the additional audit context information.
', ], ], 'AuthTokenString' => [ 'base' => NULL, 'refs' => [ 'UpdateJobFromSourceControlRequest$AuthToken' => 'The value of the authorization token.
', 'UpdateSourceControlFromJobRequest$AuthToken' => 'The value of the authorization token.
', ], ], 'BackfillError' => [ 'base' => 'A list of errors that can occur when registering partition indexes for an existing table.
These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:
EncryptedPartitionError: The partitions are encrypted.
InvalidPartitionTypeDataError: The partition value doesn\'t match the data type for that partition column.
MissingPartitionValueError: The partitions are encrypted.
UnsupportedPartitionCharacterError: Characters inside the partition value are not supported. For example: U+0000 , U+0001, U+0002.
InternalError: Any error which does not belong to other error codes.
The error code for an error that occurred when registering partition indexes for an existing table.
', ], ], 'BackfillErroredPartitionsList' => [ 'base' => NULL, 'refs' => [ 'BackfillError$Partitions' => 'A list of a limited number of partitions in the response.
', ], ], 'BackfillErrors' => [ 'base' => NULL, 'refs' => [ 'PartitionIndexDescriptor$BackfillErrors' => 'A list of errors that can occur when registering partition indexes for an existing table.
', ], ], 'BasicCatalogTarget' => [ 'base' => 'Specifies a target that uses a Glue Data Catalog table.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogTarget' => 'Specifies a target that uses a Glue Data Catalog table.
', ], ], 'BatchCreatePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchCreatePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionValueList' => [ 'base' => NULL, 'refs' => [ 'BatchDeletePartitionRequest$PartitionsToDelete' => 'A list of PartitionInput structures that define the partitions to be deleted.
A list of the table to delete.
', ], ], 'BatchDeleteTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTableVersionList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionRequest$VersionIds' => 'A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer. Each version is incremented by 1.
A list of blueprint names.
', ], ], 'BatchGetBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCustomEntityTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCustomEntityTypesResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDataQualityResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDataQualityResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionValueList' => [ 'base' => NULL, 'refs' => [ 'BatchGetPartitionRequest$PartitionsToGet' => 'A list of partition values identifying the partitions to retrieve.
', 'BatchGetPartitionResponse$UnprocessedKeys' => 'A list of the partition values in the request for which partitions were not returned.
', ], ], 'BatchGetTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchSize' => [ 'base' => NULL, 'refs' => [ 'EventBatchingCondition$BatchSize' => 'Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
', ], ], 'BatchStopJobRunError' => [ 'base' => 'Records an error that occurred when attempting to stop a specified job run.
', 'refs' => [ 'BatchStopJobRunErrorList$member' => NULL, ], ], 'BatchStopJobRunErrorList' => [ 'base' => NULL, 'refs' => [ 'BatchStopJobRunResponse$Errors' => 'A list of the errors that were encountered in trying to stop JobRuns, including the JobRunId for which each error was encountered and details about the error.
A list of the JobRunIds that should be stopped for that job definition.
Records a successful request to stop a specified JobRun.
A list of the JobRuns that were successfully submitted for stopping.
', ], ], 'BatchUpdatePartitionFailureEntry' => [ 'base' => 'Contains information about a batch update partition error.
', 'refs' => [ 'BatchUpdatePartitionFailureList$member' => NULL, ], ], 'BatchUpdatePartitionFailureList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePartitionResponse$Errors' => 'The errors encountered when trying to update the requested partitions. A list of BatchUpdatePartitionFailureEntry objects.
A structure that contains the values and structure used to update a partition.
', 'refs' => [ 'BatchUpdatePartitionRequestEntryList$member' => NULL, ], ], 'BatchUpdatePartitionRequestEntryList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePartitionRequest$Entries' => 'A list of up to 100 BatchUpdatePartitionRequestEntry objects to update.
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
', ], ], 'BinaryColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for bit sequence data values.
', 'refs' => [ 'ColumnStatisticsData$BinaryColumnStatisticsData' => 'Binary column statistics data.
', ], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'DecimalNumber$UnscaledValue' => 'The unscaled numeric value.
', ], ], 'Blueprint' => [ 'base' => 'The details of a blueprint.
', 'refs' => [ 'Blueprints$member' => NULL, 'GetBlueprintResponse$Blueprint' => 'Returns a Blueprint object.
The details of a blueprint.
', 'refs' => [ 'Workflow$BlueprintDetails' => 'This structure indicates the details of the blueprint that this particular workflow is created from.
', ], ], 'BlueprintNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetBlueprintsResponse$MissingBlueprints' => 'Returns a list of BlueprintNames that were not found.
List of names of blueprints in the account.
', ], ], 'BlueprintParameterSpec' => [ 'base' => NULL, 'refs' => [ 'Blueprint$ParameterSpec' => 'A JSON string that indicates the list of parameter specifications for the blueprint.
', 'LastActiveDefinition$ParameterSpec' => 'A JSON string specifying the parameters for the blueprint.
', ], ], 'BlueprintParameters' => [ 'base' => NULL, 'refs' => [ 'BlueprintRun$Parameters' => 'The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec.
Specifies the parameters as a BlueprintParameters object.
The details of a blueprint run.
', 'refs' => [ 'BlueprintRuns$member' => NULL, 'GetBlueprintRunResponse$BlueprintRun' => 'Returns a BlueprintRun object.
The state of the blueprint run. Possible values are:
Running — The blueprint run is in progress.
Succeeded — The blueprint run completed successfully.
Failed — The blueprint run failed and rollback is complete.
Rolling Back — The blueprint run failed and rollback is in progress.
Returns a list of BlueprintRun objects.
The status of the blueprint registration.
Creating — The blueprint registration is in progress.
Active — The blueprint has been successfully registered.
Updating — An update to the blueprint registration is in progress.
Failed — The blueprint registration failed.
Returns a list of blueprint as a Blueprints object.
True if the migration has completed, or False otherwise.
True if the value is used as a parameter.
', 'ConnectionPasswordEncryption$ReturnConnectionPasswordEncrypted' => 'When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption.
True if the crawler is still estimating how long it will take to complete this run.
', 'GetConnectionRequest$HidePassword' => 'Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
', 'GetConnectionsRequest$HidePassword' => 'Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
', 'GetUnfilteredPartitionMetadataResponse$IsRegisteredWithLakeFormation' => 'A Boolean value that indicates whether the partition location is registered with Lake Formation.
', 'GetUnfilteredTableMetadataResponse$IsRegisteredWithLakeFormation' => 'A Boolean value that indicates whether the partition location is registered with Lake Formation.
', 'StorageDescriptor$Compressed' => ' True if the data in the table is compressed, or False if not.
True if the table data is stored in subdirectories, or False if not.
Indicates whether the table has been registered with Lake Formation.
', 'UnfilteredPartition$IsRegisteredWithLakeFormation' => 'A Boolean value indicating that the partition location is registered with Lake Formation.
', ], ], 'BooleanColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for Boolean data columns.
', 'refs' => [ 'ColumnStatisticsData$BooleanColumnStatisticsData' => 'Boolean column statistics data.
', ], ], 'BooleanNullable' => [ 'base' => NULL, 'refs' => [ 'GetPartitionsRequest$ExcludeColumnSchema' => 'When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
', 'UpdateTableRequest$SkipArchive' => 'By default, UpdateTable always creates an archived version of the table before updating it. However, if skipArchive is set to true, UpdateTable does not create the archived version.
The action used on Redshift sinks when doing an APPEND.
', 'CreateTriggerRequest$StartOnCreation' => 'Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.
True if a list of predecessor runs should be returned.
', 'S3CsvSource$OptimizePerformance' => 'A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
', 'SnowflakeNodeData$Upsert' => 'Used when Action is append. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.
Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
', 'UpdateDevEndpointRequest$UpdateEtlLibraries' => ' True if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False if otherwise.
A list of values defining the partitions.
', 'BatchUpdatePartitionRequestEntry$PartitionValueList' => 'A list of values defining the partitions.
', 'UpdatePartitionRequest$PartitionValueList' => 'List of partition key values that define the partition to update.
', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'CatalogKafkaSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'CatalogKinesisSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'CatalogSchemaChangePolicy$EnableUpdateCatalog' => 'Whether to use the specified update behavior when the crawler finds a changed schema.
', 'DQResultsPublishingOptions$CloudWatchMetricsEnabled' => 'Enable metrics for your data quality results.
', 'DQResultsPublishingOptions$ResultsPublishingEnabled' => 'Enable publishing for your data quality results.
', 'DirectKafkaSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'DirectKinesisSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'DirectSchemaChangePolicy$EnableUpdateCatalog' => 'Whether to use the specified update behavior when the crawler finds a changed schema.
', 'FilterExpression$Negated' => 'Whether the expression is to be negated.
', 'KafkaStreamingSourceOptions$IncludeHeaders' => 'Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
If true, then the column is removed.
', 'NullCheckBoxList$IsEmpty' => 'Specifies that an empty string is considered as a null value.
', 'NullCheckBoxList$IsNullString' => 'Specifies that a value spelling out the word \'null\' is considered as a null value.
', 'NullCheckBoxList$IsNegOne' => 'Specifies that an integer value of -1 is considered as a null value.
', 'S3CsvSource$Recurse' => 'If set to true, recursively reads files in all subdirectories under the specified paths.
', 'S3CsvSource$Multiline' => 'A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.
A Boolean value that specifies whether to treat the first line as a header. The default value is False.
A Boolean value that specifies whether to write the header to output. The default value is True.
A Boolean value that specifies whether to skip the first data line. The default value is False.
Sets option to enable a sample path.
', 'S3JsonSource$Recurse' => 'If set to true, recursively reads files in all subdirectories under the specified paths.
', 'S3JsonSource$Multiline' => 'A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.
If set to true, recursively reads files in all subdirectories under the specified paths.
', 'TransformConfigParameter$IsOptional' => 'Specifies whether the parameter is optional or not in the config file of the dynamic transform.
', ], ], 'BoxedDoubleFraction' => [ 'base' => NULL, 'refs' => [ 'PIIDetection$SampleFraction' => 'Indicates the fraction of the data to sample when scanning for PII entities.
', 'PIIDetection$ThresholdFraction' => 'Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
', ], ], 'BoxedLong' => [ 'base' => NULL, 'refs' => [ 'S3DirectSourceAdditionalOptions$BoundedSize' => 'Sets the upper limit for the target size of the dataset in bytes that will be processed.
', 'S3DirectSourceAdditionalOptions$BoundedFiles' => 'Sets the upper limit for the target number of files that will be processed.
', 'S3SourceAdditionalOptions$BoundedSize' => 'Sets the upper limit for the target size of the dataset in bytes that will be processed.
', 'S3SourceAdditionalOptions$BoundedFiles' => 'Sets the upper limit for the target number of files that will be processed.
', ], ], 'BoxedNonNegativeInt' => [ 'base' => NULL, 'refs' => [ 'KafkaStreamingSourceOptions$NumRetries' => 'The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
', 'KinesisStreamingSourceOptions$NumRetries' => 'The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3CsvSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', 'S3JsonSource$MaxBand' => 'This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3JsonSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', 'S3ParquetSource$MaxBand' => 'This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3ParquetSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', ], ], 'BoxedNonNegativeLong' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorOptions$LowerBound' => 'The minimum value of partitionColumn that is used to decide partition stride.
The maximum value of partitionColumn that is used to decide partition stride.
The number of partitions. This value, along with lowerBound (inclusive) and upperBound (exclusive), form partition strides for generated WHERE clause expressions that are used to split the partitionColumn.
The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.
The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
The amount of time to spend processing each micro batch.
', 'CatalogKinesisSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', 'DirectKafkaSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', 'DirectKinesisSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', ], ], 'CancelDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelMLTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelMLTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'CatalogDeltaSource' => [ 'base' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogDeltaSource' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
', ], ], 'CatalogEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRest$CatalogEncryptionMode' => 'The encryption-at-rest mode for encrypting Data Catalog data.
', ], ], 'CatalogEntries' => [ 'base' => NULL, 'refs' => [ 'GetMappingRequest$Sinks' => 'A list of target tables.
', 'GetPlanRequest$Sinks' => 'The target tables.
', ], ], 'CatalogEntry' => [ 'base' => 'Specifies a table definition in the Glue Data Catalog.
', 'refs' => [ 'CatalogEntries$member' => NULL, 'GetMappingRequest$Source' => 'Specifies the source table.
', 'GetPlanRequest$Source' => 'The source table.
', ], ], 'CatalogGetterPageSize' => [ 'base' => NULL, 'refs' => [ 'GetDatabasesRequest$MaxResults' => 'The maximum number of databases to return in one response.
', 'GetTableVersionsRequest$MaxResults' => 'The maximum number of table versions to return in one response.
', 'GetTablesRequest$MaxResults' => 'The maximum number of tables to return in a single response.
', 'GetUserDefinedFunctionsRequest$MaxResults' => 'The maximum number of functions to return in one response.
', ], ], 'CatalogHudiSource' => [ 'base' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogHudiSource' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog.
', ], ], 'CatalogIdString' => [ 'base' => NULL, 'refs' => [ 'BatchCreatePartitionRequest$CatalogId' => 'The ID of the catalog in which the partition is to be created. Currently, this should be the Amazon Web Services account ID.
', 'BatchDeleteConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeletePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeleteTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeleteTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchGetPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'BatchUpdatePartitionRequest$CatalogId' => 'The ID of the catalog in which the partition is to be updated. Currently, this should be the Amazon Web Services account ID.
', 'CreateConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services account ID is used by default.
', 'CreateDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services account ID is used by default.
', 'CreatePartitionIndexRequest$CatalogId' => 'The catalog ID where the table resides.
', 'CreatePartitionRequest$CatalogId' => 'The Amazon Web Services account ID of the catalog in which the partition is to be created.
', 'CreateTableRequest$CatalogId' => 'The ID of the Data Catalog in which to create the Table. If none is supplied, the Amazon Web Services account ID is used by default.
The ID of the Data Catalog in which to create the function. If none is provided, the Amazon Web Services account ID is used by default.
', 'Database$CatalogId' => 'The ID of the Data Catalog in which the database resides.
', 'DatabaseIdentifier$CatalogId' => 'The ID of the Data Catalog in which the database resides.
', 'DeleteColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'DeleteColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'DeleteConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeletePartitionIndexRequest$CatalogId' => 'The catalog ID where the table resides.
', 'DeletePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetCatalogImportStatusRequest$CatalogId' => 'The ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.
', 'GetColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetConnectionsRequest$CatalogId' => 'The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDataCatalogEncryptionSettingsRequest$CatalogId' => 'The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDatabasesRequest$CatalogId' => 'The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.
The catalog ID where the table resides.
', 'GetPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetPartitionsRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableVersionsRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTablesRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetUnfilteredPartitionMetadataRequest$CatalogId' => 'The catalog ID where the partition resides.
', 'GetUnfilteredPartitionsMetadataRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default.
', 'GetUnfilteredTableMetadataRequest$CatalogId' => 'The catalog ID where the table resides.
', 'GetUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetUserDefinedFunctionsRequest$CatalogId' => 'The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the Amazon Web Services account ID is used by default.
', 'ImportCatalogToGlueRequest$CatalogId' => 'The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.
', 'Partition$CatalogId' => 'The ID of the Data Catalog in which the partition resides.
', 'PutDataCatalogEncryptionSettingsRequest$CatalogId' => 'The ID of the Data Catalog to set the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
', 'SearchTablesRequest$CatalogId' => 'A unique identifier, consisting of account_id .
The ID of the Data Catalog in which the table resides.
', 'TableIdentifier$CatalogId' => 'The ID of the Data Catalog in which the table resides.
', 'UpdateColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'UpdateColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'UpdateConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdatePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be updated resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be updated is located. If none is provided, the Amazon Web Services account ID is used by default.
', 'UserDefinedFunction$CatalogId' => 'The ID of the Data Catalog in which the function resides.
', ], ], 'CatalogImportStatus' => [ 'base' => 'A structure containing migration status information.
', 'refs' => [ 'GetCatalogImportStatusResponse$ImportStatus' => 'The status of the specified catalog migration.
', ], ], 'CatalogKafkaSource' => [ 'base' => 'Specifies an Apache Kafka data store in the Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogKafkaSource' => 'Specifies an Apache Kafka data store in the Data Catalog.
', ], ], 'CatalogKinesisSource' => [ 'base' => 'Specifies a Kinesis data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogKinesisSource' => 'Specifies a Kinesis data source in the Glue Data Catalog.
', ], ], 'CatalogSchemaChangePolicy' => [ 'base' => 'A policy that specifies update behavior for the crawler.
', 'refs' => [ 'GovernedCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the governed catalog.
', 'S3CatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3DeltaCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3HudiCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', ], ], 'CatalogSource' => [ 'base' => 'Specifies a data store in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogSource' => 'Specifies a data store in the Glue Data Catalog.
', ], ], 'CatalogTablesList' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$Tables' => 'A list of the tables to be synchronized.
', ], ], 'CatalogTarget' => [ 'base' => 'Specifies an Glue Data Catalog target.
', 'refs' => [ 'CatalogTargetList$member' => NULL, ], ], 'CatalogTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$CatalogTargets' => 'Specifies Glue Data Catalog targets.
', ], ], 'CheckSchemaVersionValidityInput' => [ 'base' => NULL, 'refs' => [], ], 'CheckSchemaVersionValidityResponse' => [ 'base' => NULL, 'refs' => [], ], 'Classification' => [ 'base' => NULL, 'refs' => [ 'CreateGrokClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
', 'CreateXMLClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches.
', 'GrokClassifier$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
', 'UpdateGrokClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
', 'UpdateXMLClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches.
', 'XMLClassifier$Classification' => 'An identifier of the data format that the classifier matches.
', ], ], 'Classifier' => [ 'base' => 'Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a StructType object that matches that data format.
You can use the standard classifiers that Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a grok classifier, an XML classifier, a JSON classifier, or a custom CSV classifier, as specified in one of the fields in the Classifier object.
The requested classifier.
', ], ], 'ClassifierList' => [ 'base' => NULL, 'refs' => [ 'GetClassifiersResponse$Classifiers' => 'The requested list of classifier objects.
', ], ], 'ClassifierNameList' => [ 'base' => NULL, 'refs' => [ 'Crawler$Classifiers' => 'A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
', 'CreateCrawlerRequest$Classifiers' => 'A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
', 'UpdateCrawlerRequest$Classifiers' => 'A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
', ], ], 'CloudWatchEncryption' => [ 'base' => 'Specifies how Amazon CloudWatch data should be encrypted.
', 'refs' => [ 'EncryptionConfiguration$CloudWatchEncryption' => 'The encryption configuration for Amazon CloudWatch.
', ], ], 'CloudWatchEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEncryption$CloudWatchEncryptionMode' => 'The encryption mode to use for CloudWatch data.
', ], ], 'CodeGenArgName' => [ 'base' => NULL, 'refs' => [ 'CodeGenEdge$TargetParameter' => 'The target of the edge.
', 'CodeGenNodeArg$Name' => 'The name of the argument or property.
', ], ], 'CodeGenArgValue' => [ 'base' => NULL, 'refs' => [ 'CodeGenNodeArg$Value' => 'The value of the argument or property.
', ], ], 'CodeGenConfigurationNode' => [ 'base' => ' CodeGenConfigurationNode enumerates all valid Node types. One and only one of its member variables can be populated.
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', 'Job$CodeGenConfigurationNodes' => 'The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', 'JobUpdate$CodeGenConfigurationNodes' => 'The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', ], ], 'CodeGenEdge' => [ 'base' => 'Represents a directional edge in a directed acyclic graph (DAG).
', 'refs' => [ 'DagEdges$member' => NULL, ], ], 'CodeGenIdentifier' => [ 'base' => NULL, 'refs' => [ 'CodeGenEdge$Source' => 'The ID of the node at which the edge starts.
', 'CodeGenEdge$Target' => 'The ID of the node at which the edge ends.
', 'CodeGenNode$Id' => 'A node identifier that is unique within the node\'s graph.
', ], ], 'CodeGenNode' => [ 'base' => 'Represents a node in a directed acyclic graph (DAG)
', 'refs' => [ 'DagNodes$member' => NULL, ], ], 'CodeGenNodeArg' => [ 'base' => 'An argument or property of a node.
', 'refs' => [ 'CodeGenNodeArgs$member' => NULL, ], ], 'CodeGenNodeArgs' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$Args' => 'Properties of the node, in the form of name-value pairs.
', 'Location$Jdbc' => 'A JDBC location.
', 'Location$S3' => 'An Amazon Simple Storage Service (Amazon S3) location.
', 'Location$DynamoDB' => 'An Amazon DynamoDB table location.
', ], ], 'CodeGenNodeType' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$NodeType' => 'The type of node that this is.
', ], ], 'Column' => [ 'base' => 'A column in a Table.
Encapsulates a column name that failed and the reason for failure.
', 'refs' => [ 'ColumnErrors$member' => NULL, ], ], 'ColumnErrors' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionResponse$Errors' => 'Error occurred during retrieving column statistics data.
', 'GetColumnStatisticsForTableResponse$Errors' => 'List of ColumnStatistics that failed to be retrieved.
', ], ], 'ColumnImportance' => [ 'base' => 'A structure containing the column name and column importance score for a column.
Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.
', 'refs' => [ 'ColumnImportanceList$member' => NULL, ], ], 'ColumnImportanceList' => [ 'base' => NULL, 'refs' => [ 'FindMatchesMetrics$ColumnImportances' => 'A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.
A list of the Columns in the table.
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
', 'SchemaColumn$Name' => 'The name of the column.
', ], ], 'ColumnRowFilter' => [ 'base' => 'A filter that uses both column-level and row-level filtering.
', 'refs' => [ 'ColumnRowFilterList$member' => NULL, ], ], 'ColumnRowFilterList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredTableMetadataResponse$CellFilters' => 'A list of column row filters.
', ], ], 'ColumnStatistics' => [ 'base' => 'Represents the generated column-level statistics for a table or partition.
', 'refs' => [ 'ColumnStatisticsError$ColumnStatistics' => 'The ColumnStatistics of the column.
Contains the individual types of column statistics data. Only one data object should be set and indicated by the Type attribute.
A ColumnStatisticData object that contains the statistics data values.
Encapsulates a ColumnStatistics object that failed and the reason for failure.
Error occurred during updating column statistics data.
', 'UpdateColumnStatisticsForTableResponse$Errors' => 'List of ColumnStatisticsErrors.
', ], ], 'ColumnStatisticsList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionResponse$ColumnStatisticsList' => 'List of ColumnStatistics that failed to be retrieved.
', 'GetColumnStatisticsForTableResponse$ColumnStatisticsList' => 'List of ColumnStatistics.
', ], ], 'ColumnStatisticsType' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsData$Type' => 'The type of column statistics data.
', ], ], 'ColumnTypeString' => [ 'base' => NULL, 'refs' => [ 'Column$Type' => 'The data type of the Column.
The hive type for this column in the Glue Studio schema.
', 'KeySchemaElement$Type' => 'The type of a partition key.
', 'SchemaColumn$DataType' => 'The type of data in the column.
', ], ], 'ColumnValueStringList' => [ 'base' => NULL, 'refs' => [ 'SkewedInfo$SkewedColumnValues' => 'A list of values that appear so frequently as to be considered skewed.
', ], ], 'ColumnValuesString' => [ 'base' => NULL, 'refs' => [ 'ColumnValueStringList$member' => NULL, 'LocationMap$key' => NULL, 'LocationMap$value' => NULL, ], ], 'CommentString' => [ 'base' => NULL, 'refs' => [ 'Column$Comment' => 'A free-form text comment.
', ], ], 'CommitIdString' => [ 'base' => NULL, 'refs' => [ 'UpdateJobFromSourceControlRequest$CommitId' => 'A commit ID for a commit in the remote repository.
', 'UpdateSourceControlFromJobRequest$CommitId' => 'A commit ID for a commit in the remote repository.
', ], ], 'Comparator' => [ 'base' => NULL, 'refs' => [ 'PropertyPredicate$Comparator' => 'The comparator used to compare this property to others.
', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaInput$Compatibility' => 'The compatibility mode of the schema. The possible values are:
NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can\'t be read by readers using the previous version.
BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
The schema compatibility mode.
', 'GetSchemaResponse$Compatibility' => 'The compatibility mode of the schema.
', 'UpdateSchemaInput$Compatibility' => 'The new compatibility setting for the schema.
', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'S3CsvSource$CompressionType' => '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 how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip").
Two processes are trying to modify a resource simultaneously.
', 'refs' => [], ], 'ConcurrentRunsExceededException' => [ 'base' => 'Too many jobs are being run concurrently.
', 'refs' => [], ], 'Condition' => [ 'base' => 'Defines a condition under which a trigger fires.
', 'refs' => [ 'ConditionList$member' => NULL, ], ], 'ConditionCheckFailureException' => [ 'base' => 'A specified condition was not satisfied.
', 'refs' => [], ], 'ConditionList' => [ 'base' => NULL, 'refs' => [ 'Predicate$Conditions' => 'A list of the conditions that determine when the trigger will fire.
', ], ], 'ConflictException' => [ 'base' => 'The CreatePartitions API was called on a table that has indexes enabled.
The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
', 'refs' => [ 'FindMatchesMetrics$ConfusionMatrix' => 'The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
', ], ], 'Connection' => [ 'base' => 'Defines a connection to a data source.
', 'refs' => [ 'ConnectionList$member' => NULL, 'GetConnectionResponse$Connection' => 'The requested connection definition.
', ], ], 'ConnectionInput' => [ 'base' => 'A structure that is used to specify a connection to create or update.
', 'refs' => [ 'CreateConnectionRequest$ConnectionInput' => 'A ConnectionInput object defining the connection to create.
A ConnectionInput object that redefines the connection in question.
A list of requested connection definitions.
', ], ], 'ConnectionName' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$ConnectionName' => 'The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
The name of the connection to use to connect to the Delta table target.
', 'HudiTarget$ConnectionName' => 'The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
', 'IcebergTarget$ConnectionName' => 'The name of the connection to use to connect to the Iceberg target.
', 'JdbcTarget$ConnectionName' => 'The name of the connection to use to connect to the JDBC target.
', 'MongoDBTarget$ConnectionName' => 'The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
', 'S3Target$ConnectionName' => 'The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
', ], ], 'ConnectionPasswordEncryption' => [ 'base' => 'The data structure used by the Data Catalog to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.
When a CreationConnection request arrives containing a password, the Data Catalog first encrypts the password using your KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.
This encryption requires that you set KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.
', 'refs' => [ 'DataCatalogEncryptionSettings$ConnectionPasswordEncryption' => 'When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.
These key-value pairs define parameters for the connection:
HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME".
PASSWORD - A password, if one is used, for the user name.
ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
JDBC_ENGINE - The name of the JDBC engine to use.
JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
CONFIG_FILES - (Reserved for future use.)
INSTANCE_ID - The instance ID to use.
JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer\'s root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.
CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.
SECRET_ID - The secret ID used for the secret manager of credentials.
CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.
CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.
CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.
KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".
KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".
KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).
KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_MECHANISM - "SCRAM-SHA-512", "GSSAPI", or "AWS_MSK_IAM". These are the supported SASL Mechanisms.
KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.
KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN - The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
These key-value pairs define parameters for the connection.
', ], ], 'ConnectionPropertyKey' => [ 'base' => NULL, 'refs' => [ 'ConnectionProperties$key' => NULL, ], ], 'ConnectionType' => [ 'base' => NULL, 'refs' => [ 'Connection$ConnectionType' => 'The type of the connection. Currently, SFTP is not supported.
', 'ConnectionInput$ConnectionType' => 'The type of the connection. Currently, these types are supported:
JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
JDBC Connections use the following ConnectionParameters.
Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.
Required: All of (USERNAME, PASSWORD) or SECRET_ID.
Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
KAFKA - Designates a connection to an Apache Kafka streaming platform.
KAFKA Connections use the following ConnectionParameters.
Required: KAFKA_BOOTSTRAP_SERVERS.
Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.
Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.
Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.
Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.
Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.
MONGODB - Designates a connection to a MongoDB document database.
MONGODB Connections use the following ConnectionParameters.
Required: CONNECTION_URL.
Required: All of (USERNAME, PASSWORD) or SECRET_ID.
NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
MARKETPLACE Connections use the following ConnectionParameters.
Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.
Required for JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.
CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
SFTP is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
', 'GetConnectionsFilter$ConnectionType' => 'The type of connections to return. Currently, SFTP is not supported.
', ], ], 'ConnectionsList' => [ 'base' => 'Specifies the connections used by a job.
', 'refs' => [ 'CreateJobRequest$Connections' => 'The connections used for this job.
', 'CreateSessionRequest$Connections' => 'The number of connections to use for the session.
', 'Job$Connections' => 'The connections used for this job.
', 'JobUpdate$Connections' => 'The connections used for this job.
', 'Session$Connections' => 'The number of connections used for the session.
', ], ], 'ContextWords' => [ 'base' => NULL, 'refs' => [ 'CreateCustomEntityTypeRequest$ContextWords' => 'A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
', 'CustomEntityType$ContextWords' => 'A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
', 'GetCustomEntityTypeResponse$ContextWords' => 'A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
', ], ], 'Crawl' => [ 'base' => 'The details of a crawl in the workflow.
', 'refs' => [ 'CrawlList$member' => NULL, ], ], 'CrawlId' => [ 'base' => NULL, 'refs' => [ 'CrawlerHistory$CrawlId' => 'A UUID identifier for each crawl.
', ], ], 'CrawlList' => [ 'base' => NULL, 'refs' => [ 'CrawlerNodeDetails$Crawls' => 'A list of crawls represented by the crawl node.
', ], ], 'CrawlState' => [ 'base' => NULL, 'refs' => [ 'Condition$CrawlState' => 'The state of the crawler to which this condition applies.
', 'Crawl$State' => 'The state of the crawler.
', ], ], 'Crawler' => [ 'base' => 'Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the Glue Data Catalog.
', 'refs' => [ 'CrawlerList$member' => NULL, 'GetCrawlerResponse$Crawler' => 'The metadata for the specified crawler.
', ], ], 'CrawlerConfiguration' => [ 'base' => NULL, 'refs' => [ 'Crawler$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', 'CreateCrawlerRequest$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', 'UpdateCrawlerRequest$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', ], ], 'CrawlerHistory' => [ 'base' => 'Contains the information for a run of a crawler.
', 'refs' => [ 'CrawlerHistoryList$member' => NULL, ], ], 'CrawlerHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListCrawlsResponse$Crawls' => 'A list of CrawlerHistory objects representing the crawl runs that meet your criteria.
The state of the crawl.
', ], ], 'CrawlerLineageSettings' => [ 'base' => NULL, 'refs' => [ 'LineageConfiguration$CrawlerLineageSettings' => 'Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
A list of crawler definitions.
', 'GetCrawlersResponse$Crawlers' => 'A list of crawler metadata.
', ], ], 'CrawlerMetrics' => [ 'base' => 'Metrics for a specified crawler.
', 'refs' => [ 'CrawlerMetricsList$member' => NULL, ], ], 'CrawlerMetricsList' => [ 'base' => NULL, 'refs' => [ 'GetCrawlerMetricsResponse$CrawlerMetricsList' => 'A list of metrics for the specified crawler.
', ], ], 'CrawlerNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetCrawlersRequest$CrawlerNames' => 'A list of crawler names, which might be the names returned from the ListCrawlers operation.
A list of names of crawlers that were not found.
', 'GetCrawlerMetricsRequest$CrawlerNameList' => 'A list of the names of crawlers about which to retrieve metrics.
', 'ListCrawlersResponse$CrawlerNames' => 'The names of all crawlers in the account, or the crawlers with the specified tags.
', ], ], 'CrawlerNodeDetails' => [ 'base' => 'The details of a Crawler node present in the workflow.
', 'refs' => [ 'Node$CrawlerDetails' => 'Details of the crawler when the node represents a crawler.
', ], ], 'CrawlerNotRunningException' => [ 'base' => 'The specified crawler is not running.
', 'refs' => [], ], 'CrawlerRunningException' => [ 'base' => 'The operation cannot be performed because the crawler is already running.
', 'refs' => [], ], 'CrawlerSecurityConfiguration' => [ 'base' => NULL, 'refs' => [ 'Crawler$CrawlerSecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used by this crawler.
The name of the SecurityConfiguration structure to be used by this crawler.
The name of the SecurityConfiguration structure to be used by this crawler.
Indicates whether the crawler is running, or whether a run is pending.
', ], ], 'CrawlerStoppingException' => [ 'base' => 'The specified crawler is stopping.
', 'refs' => [], ], 'CrawlerTargets' => [ 'base' => 'Specifies data stores to crawl.
', 'refs' => [ 'Crawler$Targets' => 'A collection of targets to crawl.
', 'CreateCrawlerRequest$Targets' => 'A list of collection of targets to crawl.
', 'UpdateCrawlerRequest$Targets' => 'A list of targets to crawl.
', ], ], 'CrawlsFilter' => [ 'base' => 'A list of fields, comparators and value that you can use to filter the crawler runs for a specified crawler.
', 'refs' => [ 'CrawlsFilterList$member' => NULL, ], ], 'CrawlsFilterList' => [ 'base' => NULL, 'refs' => [ 'ListCrawlsRequest$Filters' => 'Filters the crawls by the criteria you specify in a list of CrawlsFilter objects.
Specifies a custom CSV classifier for CreateClassifier to create.
A CsvClassifier object specifying the classifier to create.
Specifies a grok classifier for CreateClassifier to create.
A GrokClassifier object specifying the classifier to create.
Specifies a JSON classifier for CreateClassifier to create.
A JsonClassifier object specifying the classifier to create.
Request to create a new session.
', 'refs' => [], ], 'CreateSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateXMLClassifierRequest' => [ 'base' => 'Specifies an XML classifier for CreateClassifier to create.
An XMLClassifier object specifying the classifier to create.
The date and time the registry was created.
', 'GetSchemaByDefinitionResponse$CreatedTime' => 'The date and time the schema was created.
', 'GetSchemaResponse$CreatedTime' => 'The date and time the schema was created.
', 'GetSchemaVersionResponse$CreatedTime' => 'The date and time the schema version was created.
', 'MetadataInfo$CreatedTime' => 'The time at which the entry was created.
', 'OtherMetadataValueListItem$CreatedTime' => 'The time at which the entry was created.
', 'RegistryListItem$CreatedTime' => 'The data the registry was created.
', 'SchemaListItem$CreatedTime' => 'The date and time that a schema was created.
', 'SchemaVersionListItem$CreatedTime' => 'The date and time the schema version was created.
', ], ], 'CronExpression' => [ 'base' => NULL, 'refs' => [ 'CreateCrawlerRequest$Schedule' => 'A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
The updated cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
A classifier for custom CSV content.
A classifier for comma-separated values (CSV).
', ], ], 'CsvColumnDelimiter' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', 'CsvClassifier$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', 'UpdateCsvClassifierRequest$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', ], ], 'CsvHeader' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Header' => 'A list of strings representing column names.
', 'CsvClassifier$Header' => 'A list of strings representing column names.
', 'UpdateCsvClassifierRequest$Header' => 'A list of strings representing column names.
', ], ], 'CsvHeaderOption' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', 'CsvClassifier$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', 'UpdateCsvClassifierRequest$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', ], ], 'CsvQuoteSymbol' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.
', 'CsvClassifier$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
', 'UpdateCsvClassifierRequest$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
', ], ], 'CustomCode' => [ 'base' => 'Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
', 'refs' => [ 'CodeGenConfigurationNode$CustomCode' => 'Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
', ], ], 'CustomDatatypes' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$CustomDatatypes' => 'Creates a list of supported custom datatypes.
', 'CsvClassifier$CustomDatatypes' => 'A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
', 'UpdateCsvClassifierRequest$CustomDatatypes' => 'Specifies a list of supported custom datatypes.
', ], ], 'CustomEntityType' => [ 'base' => 'An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.
', 'refs' => [ 'CustomEntityTypes$member' => NULL, ], ], 'CustomEntityTypeNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomEntityTypesRequest$Names' => 'A list of names of the custom patterns that you want to retrieve.
', 'BatchGetCustomEntityTypesResponse$CustomEntityTypesNotFound' => 'A list of the names of custom patterns that were not found.
', ], ], 'CustomEntityTypes' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomEntityTypesResponse$CustomEntityTypes' => 'A list of CustomEntityType objects representing the custom patterns that have been created.
A list of CustomEntityType objects representing custom patterns.
Optional custom grok patterns used by this classifier.
', 'GrokClassifier$CustomPatterns' => 'Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.
', 'UpdateGrokClassifierRequest$CustomPatterns' => 'Optional custom grok patterns used by this classifier.
', ], ], 'DQAdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQualityMultiFrame$AdditionalOptions' => 'Options to configure runtime behavior of the transform.
', ], ], 'DQDLAliases' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQualityMultiFrame$AdditionalDataSources' => 'The aliases of all data sources except primary.
', ], ], 'DQDLString' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQuality$Ruleset' => 'The ruleset for your data quality evaluation.
', 'EvaluateDataQualityMultiFrame$Ruleset' => 'The ruleset for your data quality evaluation.
', ], ], 'DQResultsPublishingOptions' => [ 'base' => 'Options to configure how your data quality evaluation results are published.
', 'refs' => [ 'EvaluateDataQuality$PublishingOptions' => 'Options to configure how your results are published.
', 'EvaluateDataQualityMultiFrame$PublishingOptions' => 'Options to configure how your results are published.
', ], ], 'DQStopJobOnFailureOptions' => [ 'base' => 'Options to configure how your job will stop if your data quality evaluation fails.
', 'refs' => [ 'EvaluateDataQuality$StopJobOnFailureOptions' => 'Options to configure how your job will stop if your data quality evaluation fails.
', 'EvaluateDataQualityMultiFrame$StopJobOnFailureOptions' => 'Options to configure how your job will stop if your data quality evaluation fails.
', ], ], 'DQStopJobOnFailureTiming' => [ 'base' => NULL, 'refs' => [ 'DQStopJobOnFailureOptions$StopJobOnFailureTiming' => 'When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
', ], ], 'DQTransformOutput' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQuality$Output' => 'The output of your data quality evaluation.
', ], ], 'DagEdges' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$DagEdges' => 'A list of the edges in the DAG.
', 'GetDataflowGraphResponse$DagEdges' => 'A list of the edges in the resulting DAG.
', ], ], 'DagNodes' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$DagNodes' => 'A list of the nodes in the DAG.
', 'GetDataflowGraphResponse$DagNodes' => 'A list of the nodes in the resulting DAG.
', ], ], 'DataCatalogEncryptionSettings' => [ 'base' => 'Contains configuration information for maintaining Data Catalog security.
', 'refs' => [ 'GetDataCatalogEncryptionSettingsResponse$DataCatalogEncryptionSettings' => 'The requested security configuration.
', 'PutDataCatalogEncryptionSettingsRequest$DataCatalogEncryptionSettings' => 'The security configuration to set.
', ], ], 'DataFormat' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityInput$DataFormat' => 'The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The Lake Formation principal.
', 'refs' => [ 'PrincipalPermissions$Principal' => 'The principal who is granted permissions.
', ], ], 'DataLakePrincipalString' => [ 'base' => NULL, 'refs' => [ 'DataLakePrincipal$DataLakePrincipalIdentifier' => 'An identifier for the Lake Formation principal.
', ], ], 'DataQualityEvaluationRunAdditionalRunOptions' => [ 'base' => 'Additional run options you can specify for an evaluation run.
', 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$AdditionalRunOptions' => 'Additional run options you can specify for an evaluation run.
', 'StartDataQualityRulesetEvaluationRunRequest$AdditionalRunOptions' => 'Additional run options you can specify for an evaluation run.
', ], ], 'DataQualityResult' => [ 'base' => 'Describes a data quality result.
', 'refs' => [ 'DataQualityResultsList$member' => NULL, ], ], 'DataQualityResultDescription' => [ 'base' => 'Describes a data quality result.
', 'refs' => [ 'DataQualityResultDescriptionList$member' => NULL, ], ], 'DataQualityResultDescriptionList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityResultsResponse$Results' => 'A list of DataQualityResultDescription objects.
Criteria used to return data quality results.
', 'refs' => [ 'ListDataQualityResultsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityResultIdList' => [ 'base' => NULL, 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$ResultIds' => 'A list of result IDs for the data quality results for the run.
', ], ], 'DataQualityResultIds' => [ 'base' => NULL, 'refs' => [ 'BatchGetDataQualityResultRequest$ResultIds' => 'A list of unique result IDs for the data quality results.
', 'BatchGetDataQualityResultResponse$ResultsNotFound' => 'A list of result IDs for which results were not found.
', ], ], 'DataQualityResultsList' => [ 'base' => NULL, 'refs' => [ 'BatchGetDataQualityResultResponse$Results' => 'A list of DataQualityResult objects representing the data quality results.
Describes the result of a data quality rule recommendation run.
', 'refs' => [ 'DataQualityRuleRecommendationRunList$member' => NULL, ], ], 'DataQualityRuleRecommendationRunFilter' => [ 'base' => 'A filter for listing data quality recommendation runs.
', 'refs' => [ 'ListDataQualityRuleRecommendationRunsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRuleRecommendationRunList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRuleRecommendationRunsResponse$Runs' => 'A list of DataQualityRuleRecommendationRunDescription objects.
Describes the result of the evaluation of a data quality rule.
', 'refs' => [ 'DataQualityRuleResults$member' => NULL, ], ], 'DataQualityRuleResultStatus' => [ 'base' => NULL, 'refs' => [ 'DataQualityRuleResult$Result' => 'A pass or fail status for the rule.
', ], ], 'DataQualityRuleResults' => [ 'base' => NULL, 'refs' => [ 'DataQualityResult$RuleResults' => 'A list of DataQualityRuleResult objects representing the results for each rule.
A list of DataQualityRuleResult objects representing the results for each rule.
Describes the result of a data quality ruleset evaluation run.
', 'refs' => [ 'DataQualityRulesetEvaluationRunList$member' => NULL, ], ], 'DataQualityRulesetEvaluationRunFilter' => [ 'base' => 'The filter criteria.
', 'refs' => [ 'ListDataQualityRulesetEvaluationRunsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRulesetEvaluationRunList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRulesetEvaluationRunsResponse$Runs' => 'A list of DataQualityRulesetEvaluationRunDescription objects representing data quality ruleset runs.
The criteria used to filter data quality rulesets.
', 'refs' => [ 'ListDataQualityRulesetsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRulesetList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRulesetsResponse$Rulesets' => 'A paginated list of rulesets for the specified list of Glue tables.
', ], ], 'DataQualityRulesetListDetails' => [ 'base' => 'Describes a data quality ruleset returned by GetDataQualityRuleset.
A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'GetDataQualityRuleRecommendationRunResponse$RecommendedRuleset' => 'When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.
', 'GetDataQualityRulesetResponse$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'UpdateDataQualityRulesetRequest$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'UpdateDataQualityRulesetResponse$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', ], ], 'DataQualityTargetTable' => [ 'base' => 'An object representing an Glue table.
', 'refs' => [ 'CreateDataQualityRulesetRequest$TargetTable' => 'A target table associated with the data quality ruleset.
', 'DataQualityRulesetFilterCriteria$TargetTable' => 'The name and database name of the target table.
', 'DataQualityRulesetListDetails$TargetTable' => 'An object representing an Glue table.
', 'GetDataQualityRulesetResponse$TargetTable' => 'The name and database name of the target table.
', ], ], 'DataSource' => [ 'base' => 'A data source (an Glue table) for which you want data quality results.
', 'refs' => [ 'DataQualityResult$DataSource' => 'The table associated with the data quality result, if any.
', 'DataQualityResultDescription$DataSource' => 'The table name associated with the data quality result.
', 'DataQualityResultFilterCriteria$DataSource' => 'Filter results by the specified data source. For example, retrieving all results for an Glue table.
', 'DataQualityRuleRecommendationRunDescription$DataSource' => 'The data source (Glue table) associated with the recommendation run.
', 'DataQualityRuleRecommendationRunFilter$DataSource' => 'Filter based on a specified data source (Glue table).
', 'DataQualityRulesetEvaluationRunDescription$DataSource' => 'The data source (an Glue table) associated with the run.
', 'DataQualityRulesetEvaluationRunFilter$DataSource' => 'Filter based on a data source (an Glue table) associated with the run.
', 'DataSourceMap$value' => NULL, 'GetDataQualityResultResponse$DataSource' => 'The table associated with the data quality result, if any.
', 'GetDataQualityRuleRecommendationRunResponse$DataSource' => 'The data source (an Glue table) associated with this run.
', 'GetDataQualityRulesetEvaluationRunResponse$DataSource' => 'The data source (an Glue table) associated with this evaluation run.
', 'StartDataQualityRuleRecommendationRunRequest$DataSource' => 'The data source (Glue table) associated with this run.
', 'StartDataQualityRulesetEvaluationRunRequest$DataSource' => 'The data source (Glue table) associated with this run.
', ], ], 'DataSourceMap' => [ 'base' => NULL, 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$AdditionalDataSources' => 'A map of reference strings to additional data sources you can specify for an evaluation run.
', 'StartDataQualityRulesetEvaluationRunRequest$AdditionalDataSources' => 'A map of reference strings to additional data sources you can specify for an evaluation run.
', ], ], 'Database' => [ 'base' => 'The Database object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.
The definition of the specified database in the Data Catalog.
', ], ], 'DatabaseIdentifier' => [ 'base' => 'A structure that describes a target database for resource linking.
', 'refs' => [ 'Database$TargetDatabase' => 'A DatabaseIdentifier structure that describes a target database for resource linking.
A DatabaseIdentifier structure that describes a target database for resource linking.
The structure used to create or update a database.
', 'refs' => [ 'CreateDatabaseRequest$DatabaseInput' => 'The metadata for the database.
', 'UpdateDatabaseRequest$DatabaseInput' => 'A DatabaseInput object specifying the new definition of the metadata database in the catalog.
A list of Database objects from the specified catalog.
The name of the database in which the crawler\'s output is stored.
', 'CreateCrawlerRequest$DatabaseName' => 'The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.
A structure representing the datatype of the value.
', 'refs' => [ 'NullValueField$Datatype' => 'The datatype of the value.
', ], ], 'DateColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for timestamp data columns.
', 'refs' => [ 'ColumnStatisticsData$DateColumnStatisticsData' => 'Date column statistics data.
', ], ], 'DecimalColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for fixed-point number data columns.
', 'refs' => [ 'ColumnStatisticsData$DecimalColumnStatisticsData' => 'Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two\'s complement representations of the decimal\'s unscaled value.
', ], ], 'DecimalNumber' => [ 'base' => 'Contains a numeric value in decimal format.
', 'refs' => [ 'DecimalColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DecimalColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'DeleteBehavior' => [ 'base' => NULL, 'refs' => [ 'SchemaChangePolicy$DeleteBehavior' => 'The deletion behavior when the crawler finds a deleted object.
', ], ], 'DeleteBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionNameList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionRequest$ConnectionNameList' => 'A list of names of the connections to delete.
', ], ], 'DeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomEntityTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomEntityTypeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityRulesetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityRulesetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatabaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDevEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDevEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMLTransformRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMLTransformResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistryInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeltaTarget' => [ 'base' => 'Specifies a Delta data store to crawl one or more Delta tables.
', 'refs' => [ 'DeltaTargetList$member' => NULL, ], ], 'DeltaTargetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3DeltaDirectTarget$Compression' => '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 Delta data store targets.
', ], ], 'DescriptionString' => [ 'base' => NULL, 'refs' => [ 'Connection$Description' => 'The description of the connection.
', 'ConnectionInput$Description' => 'The description of the connection.
', 'Crawl$ErrorMessage' => 'The error message associated with the crawl.
', 'Crawler$Description' => 'A description of the crawler.
', 'CrawlerHistory$ErrorMessage' => 'If an error occurred, the error message associated with the crawl.
', 'CreateCrawlerRequest$Description' => 'A description of the new crawler.
', 'CreateDataQualityRulesetRequest$Description' => 'A description of the data quality ruleset.
', 'CreateJobRequest$Description' => 'Description of the job being defined.
', 'CreateMLTransformRequest$Description' => 'A description of the machine learning transform that is being defined. The default is an empty string.
', 'CreateRegistryInput$Description' => 'A description of the registry. If description is not provided, there will not be any default value for this.
', 'CreateRegistryResponse$Description' => 'A description of the registry.
', 'CreateSchemaInput$Description' => 'An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
', 'CreateSchemaResponse$Description' => 'A description of the schema if specified when created.
', 'CreateSessionRequest$Description' => 'The description of the session.
', 'CreateTriggerRequest$Description' => 'A description of the new trigger.
', 'DataQualityRuleResult$Description' => 'A description of the data quality rule.
', 'DataQualityRuleResult$EvaluationMessage' => 'An evaluation message.
', 'DataQualityRulesetFilterCriteria$Description' => 'The description of the ruleset filter criteria.
', 'DataQualityRulesetListDetails$Description' => 'A description of the data quality ruleset.
', 'Database$Description' => 'A description of the database.
', 'DatabaseInput$Description' => 'A description of the database.
', 'ErrorDetail$ErrorMessage' => 'A message describing the error.
', 'GetDataQualityRulesetResponse$Description' => 'A description of the ruleset.
', 'GetMLTransformResponse$Description' => 'A description of the transform.
', 'GetRegistryResponse$Description' => 'A description of the registry.
', 'GetSchemaResponse$Description' => 'A description of schema if specified when created
', 'GlueTableAdditionalOptions$value' => NULL, 'Job$Description' => 'A description of the job.
', 'JobUpdate$Description' => 'Description of the job being defined.
', 'LastCrawlInfo$ErrorMessage' => 'If an error occurred, the error information about the last crawl.
', 'MLTransform$Description' => 'A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
', 'RegistryListItem$Description' => 'A description of the registry.
', 'SchemaListItem$Description' => 'A description for the schema.
', 'Session$ErrorMessage' => 'The error message displayed during the session.
', 'Session$Description' => 'The description of the session.
', 'Table$Description' => 'A description of the table.
', 'TableInput$Description' => 'A description of the table.
', 'Trigger$Description' => 'A description of this trigger.
', 'TriggerUpdate$Description' => 'A description of this trigger.
', 'UpdateDataQualityRulesetRequest$Description' => 'A description of the ruleset.
', 'UpdateDataQualityRulesetResponse$Description' => 'A description of the ruleset.
', 'UpdateMLTransformRequest$Description' => 'A description of the transform. The default is an empty string.
', 'UpdateRegistryInput$Description' => 'A description of the registry. If description is not provided, this field will not be updated.
', 'UpdateSchemaInput$Description' => 'The new description for the schema.
', ], ], 'DescriptionStringRemovable' => [ 'base' => NULL, 'refs' => [ 'UpdateCrawlerRequest$Description' => 'A description of the new crawler.
', ], ], 'DevEndpoint' => [ 'base' => 'A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.
', 'refs' => [ 'DevEndpointList$member' => NULL, 'GetDevEndpointResponse$DevEndpoint' => 'A DevEndpoint definition.
Custom libraries to be loaded into a development endpoint.
', 'refs' => [ 'UpdateDevEndpointRequest$CustomLibraries' => 'Custom Python or Java libraries to be loaded in the DevEndpoint.
A list of DevEndpoint definitions.
A list of DevEndpoint definitions.
The names of all the DevEndpoints in the account, or the DevEndpoints with the specified tags.
The list of DevEndpoint names, which might be the names returned from the ListDevEndpoint operation.
A list of DevEndpoints not found.
Specifies the direct JDBC source connection.
', 'refs' => [ 'CodeGenConfigurationNode$DirectJDBCSource' => NULL, ], ], 'DirectKafkaSource' => [ 'base' => 'Specifies an Apache Kafka data store.
', 'refs' => [ 'CodeGenConfigurationNode$DirectKafkaSource' => 'Specifies an Apache Kafka data store.
', ], ], 'DirectKinesisSource' => [ 'base' => 'Specifies a direct Amazon Kinesis data source.
', 'refs' => [ 'CodeGenConfigurationNode$DirectKinesisSource' => 'Specifies a direct Amazon Kinesis data source.
', ], ], 'DirectSchemaChangePolicy' => [ 'base' => 'A policy that specifies update behavior for the crawler.
', 'refs' => [ 'S3DeltaDirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3DirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3GlueParquetTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3HudiDirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'DoubleColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DoubleColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'DoubleColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for floating-point number data columns.
', 'refs' => [ 'ColumnStatisticsData$DoubleColumnStatisticsData' => 'Double column statistics data.
', ], ], 'DoubleValue' => [ 'base' => NULL, 'refs' => [ 'Session$Progress' => 'The code execution progress of the session.
', 'Statement$Progress' => 'The code execution progress.
', ], ], 'DropDuplicates' => [ 'base' => 'Specifies a transform that removes rows of repeating data from a data set.
', 'refs' => [ 'CodeGenConfigurationNode$DropDuplicates' => 'Specifies a transform that removes rows of repeating data from a data set.
', ], ], 'DropFields' => [ 'base' => 'Specifies a transform that chooses the data property keys that you want to drop.
', 'refs' => [ 'CodeGenConfigurationNode$DropFields' => 'Specifies a transform that chooses the data property keys that you want to drop.
', ], ], 'DropNullFields' => [ 'base' => 'Specifies a transform that removes columns from the dataset if all values in the column are \'null\'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
', 'refs' => [ 'CodeGenConfigurationNode$DropNullFields' => 'Specifies a transform that removes columns from the dataset if all values in the column are \'null\'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
', ], ], 'DynamicTransform' => [ 'base' => 'Specifies the set of parameters needed to perform the dynamic transform.
', 'refs' => [ 'CodeGenConfigurationNode$DynamicTransform' => 'Specifies a custom visual transform created by a user.
', ], ], 'DynamoDBCatalogSource' => [ 'base' => 'Specifies a DynamoDB data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$DynamoDBCatalogSource' => 'Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
', ], ], 'DynamoDBTarget' => [ 'base' => 'Specifies an Amazon DynamoDB table to crawl.
', 'refs' => [ 'DynamoDBTargetList$member' => NULL, ], ], 'DynamoDBTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$DynamoDBTargets' => 'Specifies Amazon DynamoDB targets.
', ], ], 'Edge' => [ 'base' => 'An edge represents a directed connection between two Glue components that are part of the workflow the edge belongs to.
', 'refs' => [ 'EdgeList$member' => NULL, ], ], 'EdgeList' => [ 'base' => NULL, 'refs' => [ 'WorkflowGraph$Edges' => 'A list of all the directed connections between the nodes belonging to the workflow.
', ], ], 'EnableAdditionalMetadata' => [ 'base' => NULL, 'refs' => [ 'JdbcTarget$EnableAdditionalMetadata' => 'Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
', ], ], 'EnableHybridValues' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$EnableHybrid' => 'If \'TRUE\', indicates that you are using both methods to grant cross-account access to Data Catalog resources:
By directly updating the resource policy with PutResourePolicy
By using the Grant permissions command on the Amazon Web Services Management Console.
Must be set to \'TRUE\' if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is \'FALSE\'.
Specifies the column on the data set on which the aggregation function will be applied.
', 'FilterValue$Value' => 'The value to be associated.
', 'GlueStudioPathList$member' => NULL, 'JDBCConnectorOptions$JobBookmarkKeys' => 'The name of the job bookmark keys on which to sort.
', 'Mapping$FromPath' => 'The table or column to be modified.
', 'PIIDetection$EntityTypesToDetect' => 'Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
', 'RenameField$SourcePath' => 'A JSON path to a variable in the data structure for the source data.
', 'RenameField$TargetPath' => 'A JSON path to a variable in the data structure for the target data.
', 'S3CsvSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3CsvSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'S3DeltaSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3HudiSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3JsonSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3JsonSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'S3ParquetSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3ParquetSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'TransformConfigParameter$Value' => 'Specifies the value of the parameter in the config file of the dynamic transform.
', ], ], 'EnclosedInStringPropertiesMinOne' => [ 'base' => NULL, 'refs' => [ 'UpsertRedshiftTargetOptions$UpsertKeys' => 'The keys used to determine whether to perform an update or insert.
', ], ], 'EnclosedInStringProperty' => [ 'base' => NULL, 'refs' => [ 'AdditionalOptions$key' => NULL, 'AdditionalOptions$value' => NULL, 'AmazonRedshiftNodeData$TempDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'AthenaConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'AthenaConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'AthenaConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
', 'AthenaConnectorSource$SchemaName' => 'The name of the Cloudwatch log group to read from. For example, /aws-glue/jobs/output.
The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
', 'BasicCatalogTarget$Table' => 'The table that defines the schema of your output data. This table must already exist in the Data Catalog.
', 'CatalogDeltaSource$Database' => 'The name of the database to read from.
', 'CatalogDeltaSource$Table' => 'The name of the table in the database to read from.
', 'CatalogHudiSource$Database' => 'The name of the database to read from.
', 'CatalogHudiSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKafkaSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKafkaSource$Database' => 'The name of the database to read from.
', 'CatalogKinesisSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKinesisSource$Database' => 'The name of the database to read from.
', 'CatalogSource$Database' => 'The name of the database to read from.
', 'CatalogSource$Table' => 'The name of the table in the database to read from.
', 'CustomCode$ClassName' => 'The name defined for the custom code node class.
', 'DQDLAliases$value' => NULL, 'DQResultsPublishingOptions$ResultsS3Prefix' => 'The Amazon S3 prefix prepended to the results.
', 'DirectJDBCSource$Database' => 'The database of the JDBC source connection.
', 'DirectJDBCSource$Table' => 'The table of the JDBC source connection.
', 'DirectJDBCSource$ConnectionName' => 'The connection name of the JDBC source.
', 'DirectJDBCSource$RedshiftTmpDir' => 'The temp directory of the JDBC Redshift source.
', 'DirectSchemaChangePolicy$Table' => 'Specifies the table in the database that the schema change policy applies to.
', 'DirectSchemaChangePolicy$Database' => 'Specifies the database that the schema change policy applies to.
', 'DynamicTransform$Name' => 'Specifies the name of the dynamic transform.
', 'DynamicTransform$TransformName' => 'Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
', 'DynamicTransform$FunctionName' => 'Specifies the name of the function of the dynamic transform.
', 'DynamicTransform$Path' => 'Specifies the path of the dynamic transform source and config files.
', 'DynamicTransform$Version' => 'This field is not used and will be deprecated in future release.
', 'DynamoDBCatalogSource$Database' => 'The name of the database to read from.
', 'DynamoDBCatalogSource$Table' => 'The name of the table in the database to read from.
', 'EnclosedInStringProperties$member' => NULL, 'EnclosedInStringPropertiesMinOne$member' => NULL, 'FillMissingValues$ImputedPath' => 'A JSON path to a variable in the data structure for the dataset that is imputed.
', 'FillMissingValues$FilledPath' => 'A JSON path to a variable in the data structure for the dataset that is filled.
', 'GovernedCatalogSource$Database' => 'The database to read from.
', 'GovernedCatalogSource$Table' => 'The database table to read from.
', 'GovernedCatalogSource$PartitionPredicate' => 'Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to "" – empty by default.
The name of the table in the database to write to.
', 'GovernedCatalogTarget$Database' => 'The name of the database to write to.
', 'JDBCConnectorOptions$FilterPredicate' => 'Extra condition clause to filter data from source. For example:
BillingCity=\'Mountain View\'
When using a query instead of a table name, you should validate that the query works with the specified filterPredicate.
The name of an integer column that is used for partitioning. This option works only when it\'s included with lowerBound, upperBound, and numPartitions. This option works the same way as in the Spark SQL JDBC reader.
Specifies an ascending or descending sort order.
', 'JDBCConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'JDBCConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'JDBCConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
', 'JDBCConnectorTarget$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'JDBCConnectorTarget$ConnectorName' => 'The name of a connector that will be used.
', 'JDBCConnectorTarget$ConnectionType' => 'The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
', 'JoinColumn$From' => 'The column to be joined.
', 'KafkaStreamingSourceOptions$BootstrapServers' => 'A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".
The name of the connection.
', 'KafkaStreamingSourceOptions$TopicName' => 'The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".
The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".
A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".
An optional classification.
', 'KafkaStreamingSourceOptions$Delimiter' => 'Specifies the delimiter character.
', 'KafkaStreamingSourceOptions$StartingOffsets' => 'The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".
The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.
When this option is set to \'true\', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KafkaStreamingSourceOptions$EmitConsumerLagMetrics' => 'When this option is set to \'true\', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric\'s name is "glue.driver.streaming.maxConsumerLagInMs". The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KinesisStreamingSourceOptions$EndpointUrl' => 'The URL of the Kinesis endpoint.
', 'KinesisStreamingSourceOptions$StreamName' => 'The name of the Kinesis data stream.
', 'KinesisStreamingSourceOptions$Classification' => 'An optional classification.
', 'KinesisStreamingSourceOptions$Delimiter' => 'Specifies the delimiter character.
', 'KinesisStreamingSourceOptions$StreamArn' => 'The Amazon Resource Name (ARN) of the Kinesis data stream.
', 'KinesisStreamingSourceOptions$RoleArn' => 'The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN".
When this option is set to \'true\', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KinesisStreamingSourceOptions$EmitConsumerLagMetrics' => 'When this option is set to \'true\', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric\'s name is "glue.driver.streaming.maxConsumerLagInMs". The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'Mapping$ToKey' => 'After the apply mapping, what the name of the column should be. Can be the same as FromPath.
The type of the data to be modified.
', 'Mapping$ToType' => 'The data type that the data is to be modified to.
', 'MicrosoftSQLServerCatalogSource$Database' => 'The name of the database to read from.
', 'MicrosoftSQLServerCatalogSource$Table' => 'The name of the table in the database to read from.
', 'MicrosoftSQLServerCatalogTarget$Database' => 'The name of the database to write to.
', 'MicrosoftSQLServerCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'MySQLCatalogSource$Database' => 'The name of the database to read from.
', 'MySQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'MySQLCatalogTarget$Database' => 'The name of the database to write to.
', 'MySQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'NullValueField$Value' => 'The value of the null placeholder.
', 'Option$Value' => 'Specifies the value of the option.
', 'Option$Label' => 'Specifies the label of the option.
', 'Option$Description' => 'Specifies the description of the option.
', 'OracleSQLCatalogSource$Database' => 'The name of the database to read from.
', 'OracleSQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'OracleSQLCatalogTarget$Database' => 'The name of the database to write to.
', 'OracleSQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'PIIDetection$OutputColumnName' => 'Indicates the output column name that will contain any entity type detected in that row.
', 'PostgreSQLCatalogSource$Database' => 'The name of the database to read from.
', 'PostgreSQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'PostgreSQLCatalogTarget$Database' => 'The name of the database to write to.
', 'PostgreSQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'RecipeReference$RecipeArn' => 'The ARN of the DataBrew recipe.
', 'RedshiftSource$Database' => 'The database to read from.
', 'RedshiftSource$Table' => 'The database table to read from.
', 'RedshiftSource$RedshiftTmpDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'RedshiftSource$TmpDirIAMRole' => 'The IAM role with permissions.
', 'RedshiftTarget$Database' => 'The name of the database to write to.
', 'RedshiftTarget$Table' => 'The name of the table in the database to write to.
', 'RedshiftTarget$RedshiftTmpDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'RedshiftTarget$TmpDirIAMRole' => 'The IAM role with permissions.
', 'RelationalCatalogSource$Database' => 'The name of the database to read from.
', 'RelationalCatalogSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogDeltaSource$Database' => 'The name of the database to read from.
', 'S3CatalogDeltaSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogHudiSource$Database' => 'The name of the database to read from.
', 'S3CatalogHudiSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogSource$Database' => 'The database to read from.
', 'S3CatalogSource$Table' => 'The database table to read from.
', 'S3CatalogSource$PartitionPredicate' => 'Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to "" – empty by default.
The name of the table in the database to write to.
', 'S3CatalogTarget$Database' => 'The name of the database to write to.
', 'S3CsvSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".
The name of the table in the database to write to.
', 'S3DeltaCatalogTarget$Database' => 'The name of the database to write to.
', 'S3DeltaDirectTarget$Path' => 'The Amazon S3 path of your Delta Lake data source to write to.
', 'S3DirectSourceAdditionalOptions$SamplePath' => 'If enabled, specifies the sample path.
', 'S3DirectTarget$Path' => 'A single Amazon S3 path to write to.
', 'S3DirectTarget$Compression' => '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").
A single Amazon S3 path to write to.
', 'S3HudiCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'S3HudiCatalogTarget$Database' => 'The name of the database to write to.
', 'S3HudiDirectTarget$Path' => 'The Amazon S3 path of your Hudi data source to write to.
', 'S3JsonSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".
A JsonPath string defining the JSON data.
', 'S3ParquetSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".
Not currently used.
', 'SparkConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'SparkConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'SparkConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
', 'SparkConnectorTarget$ConnectionName' => 'The name of a connection for an Apache Spark connector.
', 'SparkConnectorTarget$ConnectorName' => 'The name of an Apache Spark connector.
', 'SparkConnectorTarget$ConnectionType' => 'The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
', 'Spigot$Path' => 'A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
', 'TransformConfigParameter$Name' => 'Specifies the name of the parameter in the config file of the dynamic transform.
', 'TransformConfigParameter$ValidationRule' => 'Specifies the validation rule in the config file of the dynamic transform.
', 'TransformConfigParameter$ValidationMessage' => 'Specifies the validation message in the config file of the dynamic transform.
', 'UpsertRedshiftTargetOptions$TableLocation' => 'The physical location of the Redshift table.
', 'UpsertRedshiftTargetOptions$ConnectionName' => 'The name of the connection to use to write to Redshift.
', ], ], 'EnclosedInStringPropertyWithQuote' => [ 'base' => NULL, 'refs' => [ 'AthenaConnectorSource$ConnectionTable' => 'The name of the table in the data source.
', 'JDBCConnectorSource$ConnectionTable' => 'The name of the table in the data source.
', 'JDBCConnectorTarget$ConnectionTable' => 'The name of the table in the data target.
', 'S3CsvSource$Escaper' => 'Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\\n, \\r, \\t, and \\0).
A temporary name given to a table, or a column in a table.
', ], ], 'EncryptionAtRest' => [ 'base' => 'Specifies the encryption-at-rest configuration for the Data Catalog.
', 'refs' => [ 'DataCatalogEncryptionSettings$EncryptionAtRest' => 'Specifies the encryption-at-rest configuration for the Data Catalog.
', ], ], 'EncryptionConfiguration' => [ 'base' => 'Specifies an encryption configuration.
', 'refs' => [ 'CreateSecurityConfigurationRequest$EncryptionConfiguration' => 'The encryption configuration for the new security configuration.
', 'SecurityConfiguration$EncryptionConfiguration' => 'The encryption configuration associated with this security configuration.
', ], ], 'EntityNotFoundException' => [ 'base' => 'A specified entity does not exist
', 'refs' => [], ], 'ErrorByName' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionResponse$Errors' => 'A map of the names of connections that were not successfully deleted to error details.
', ], ], 'ErrorCodeString' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorCode' => 'The error code for an error.
', ], ], 'ErrorDetail' => [ 'base' => 'Contains details about an error.
', 'refs' => [ 'BatchStopJobRunError$ErrorDetail' => 'Specifies details about the error that was encountered.
', 'BatchUpdatePartitionFailureEntry$ErrorDetail' => 'The details about the batch update partition error.
', 'ColumnError$Error' => 'An error message with the reason for the failure of an operation.
', 'ColumnStatisticsError$Error' => 'An error message with the reason for the failure of an operation.
', 'ErrorByName$value' => NULL, 'PartitionError$ErrorDetail' => 'The details about the partition error.
', 'TableError$ErrorDetail' => 'The details about the error.
', 'TableVersionError$ErrorDetail' => 'The details about the error.
', ], ], 'ErrorDetails' => [ 'base' => 'An object containing error details.
', 'refs' => [ 'SchemaVersionErrorItem$ErrorDetails' => 'The details of the error for the schema version.
', ], ], 'ErrorMessageString' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorMessage' => 'The error message for an error.
', ], ], 'ErrorString' => [ 'base' => NULL, 'refs' => [ 'Blueprint$ErrorMessage' => 'An error message.
', 'JobRun$ErrorMessage' => 'An error message associated with this job run.
', 'WorkflowRun$ErrorMessage' => 'This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."
Specifies your data quality evaluation criteria.
', 'refs' => [ 'CodeGenConfigurationNode$EvaluateDataQuality' => 'Specifies your data quality evaluation criteria.
', ], ], 'EvaluateDataQualityMultiFrame' => [ 'base' => 'Specifies your data quality evaluation criteria.
', 'refs' => [ 'CodeGenConfigurationNode$EvaluateDataQualityMultiFrame' => 'Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.
', ], ], 'EvaluatedMetricsMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityRuleResult$EvaluatedMetrics' => 'A map of metrics associated with the evaluation of the rule.
', ], ], 'EvaluationMetrics' => [ 'base' => 'Evaluation metrics provide an estimate of the quality of your machine learning transform.
', 'refs' => [ 'GetMLTransformResponse$EvaluationMetrics' => 'The latest evaluation metrics.
', 'MLTransform$EvaluationMetrics' => 'An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'refs' => [ 'CreateTriggerRequest$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'Trigger$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'TriggerUpdate$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', ], ], 'EventQueueArn' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$EventQueueArn' => 'A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
An execution property of a job.
', 'refs' => [ 'CreateJobRequest$ExecutionProperty' => 'An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
The amount of time (in seconds) that the run consumed resources.
', 'GetDataQualityRulesetEvaluationRunResponse$ExecutionTime' => 'The amount of time (in seconds) that the run consumed resources.
', 'GetMLTaskRunResponse$ExecutionTime' => 'The amount of time (in seconds) that the task run consumed resources.
', 'JobRun$ExecutionTime' => 'The amount of time (in seconds) that the job run consumed resources.
', 'TaskRun$ExecutionTime' => 'The amount of time (in seconds) that the task run consumed resources.
', ], ], 'ExistCondition' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$PolicyExistsCondition' => 'A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call does not depend on the existence of a policy.
Specifies configuration properties for an exporting labels task run.
', 'refs' => [ 'TaskRunProperties$ExportLabelsTaskRunProperties' => 'The configuration properties for an exporting labels task run.
', ], ], 'ExtendedString' => [ 'base' => NULL, 'refs' => [ 'CustomCode$Code' => 'The custom code that is used to perform the data transformation.
', ], ], 'FederatedDatabase' => [ 'base' => 'A database that points to an entity outside the Glue Data Catalog.
', 'refs' => [ 'Database$FederatedDatabase' => 'A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
A federated resource already exists.
', 'refs' => [], ], 'FederatedTable' => [ 'base' => 'A table that points to an entity outside the Glue Data Catalog.
', 'refs' => [ 'Table$FederatedTable' => 'A FederatedTable structure that references an entity outside the Glue Data Catalog.
A unique identifier for the federated database.
', 'FederatedTable$Identifier' => 'A unique identifier for the federated table.
', 'FederatedTable$DatabaseIdentifier' => 'A unique identifier for the federated database.
', ], ], 'FederationSourceErrorCode' => [ 'base' => NULL, 'refs' => [ 'FederationSourceException$FederationSourceErrorCode' => 'The error code of the problem.
', ], ], 'FederationSourceException' => [ 'base' => 'A federation source failed.
', 'refs' => [], ], 'FederationSourceRetryableException' => [ 'base' => NULL, 'refs' => [], ], 'FieldName' => [ 'base' => NULL, 'refs' => [ 'CrawlsFilter$FieldName' => 'A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:
CRAWL_ID: A string representing the UUID identifier for a crawl.
STATE: A string representing the state of the crawl.
START_TIME and END_TIME: The epoch timestamp in milliseconds.
DPU_HOUR: The number of data processing unit (DPU) hours used for the crawl.
The source type.
', 'MappingEntry$TargetType' => 'The target type.
', ], ], 'FillMissingValues' => [ 'base' => 'Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
', 'refs' => [ 'CodeGenConfigurationNode$FillMissingValues' => 'Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
', ], ], 'Filter' => [ 'base' => 'Specifies a transform that splits a dataset into two, based on a filter condition.
', 'refs' => [ 'CodeGenConfigurationNode$Filter' => 'Specifies a transform that splits a dataset into two, based on a filter condition.
', ], ], 'FilterExpression' => [ 'base' => 'Specifies a filter expression.
', 'refs' => [ 'FilterExpressions$member' => NULL, ], ], 'FilterExpressions' => [ 'base' => NULL, 'refs' => [ 'Filter$Filters' => 'Specifies a filter expression.
', ], ], 'FilterLogicalOperator' => [ 'base' => NULL, 'refs' => [ 'Filter$LogicalOperator' => 'The operator used to filter rows by comparing the key value to a specified value.
', ], ], 'FilterOperation' => [ 'base' => NULL, 'refs' => [ 'FilterExpression$Operation' => 'The type of operation to perform in the expression.
', ], ], 'FilterOperator' => [ 'base' => NULL, 'refs' => [ 'CrawlsFilter$FilterOperator' => 'A defined comparator that operates on the value. The available operators are:
GT: Greater than.
GE: Greater than or equal to.
LT: Less than.
LE: Less than or equal to.
EQ: Equal to.
NE: Not equal to.
A regular expression pattern. If present, only those tables whose names match the pattern are returned.
', ], ], 'FilterValue' => [ 'base' => 'Represents a single entry in the list of values for a FilterExpression.
The type of filter value.
', ], ], 'FilterValues' => [ 'base' => NULL, 'refs' => [ 'FilterExpression$Values' => 'A list of filter values.
', ], ], 'FindMatchesMetrics' => [ 'base' => 'The evaluation metrics for the find matches algorithm. The quality of your machine learning transform is measured by getting your transform to predict some matches and comparing the results to known matches from the same dataset. The quality metrics are based on a subset of your data, so they are not precise.
', 'refs' => [ 'EvaluationMetrics$FindMatchesMetrics' => 'The evaluation metrics for the find matches algorithm.
', ], ], 'FindMatchesParameters' => [ 'base' => 'The parameters to configure the find matches transform.
', 'refs' => [ 'TransformParameters$FindMatchesParameters' => 'The parameters for the find matches algorithm.
', ], ], 'FindMatchesTaskRunProperties' => [ 'base' => 'Specifies configuration properties for a Find Matches task run.
', 'refs' => [ 'TaskRunProperties$FindMatchesTaskRunProperties' => 'The configuration properties for a find matches task run.
', ], ], 'FormatString' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$InputFormat' => 'The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
The description of the blueprint.
', 'CreateBlueprintRequest$Description' => 'A description of the blueprint.
', 'LastActiveDefinition$Description' => 'The description of the blueprint.
', 'SourceControlDetails$Repository' => 'The name of the remote repository that contains the job artifacts.
', 'SourceControlDetails$Owner' => 'The owner of the remote repository that contains the job artifacts.
', 'SourceControlDetails$Branch' => 'An optional branch in the remote repository.
', 'SourceControlDetails$Folder' => 'An optional folder in the remote repository.
', 'SourceControlDetails$LastCommitId' => 'The last commit ID for a commit in the remote repository.
', 'SourceControlDetails$AuthToken' => 'The value of an authorization token.
', 'UpdateBlueprintRequest$Description' => 'A description of the blueprint.
', ], ], 'GenericBoundedDouble' => [ 'base' => NULL, 'refs' => [ 'ColumnImportance$Importance' => 'The column importance score for the column, as a decimal.
', 'DataQualityResult$Score' => 'An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
', 'FindMatchesMetrics$AreaUnderPRCurve' => 'The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$Precision' => 'The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$Recall' => 'The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$F1' => 'The maximum F1 metric indicates the transform\'s accuracy between 0 and 1, where 1 is the best accuracy.
For more information, see F1 score in Wikipedia.
', 'FindMatchesParameters$PrecisionRecallTradeoff' => 'The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
', 'FindMatchesParameters$AccuracyCostTradeoff' => 'The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
', 'GetDataQualityResultResponse$Score' => 'An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
', ], ], 'GenericLimitedString' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$AccessType' => 'The access type for the Redshift connection. Can be a direct connection or catalog connections.
', 'AmazonRedshiftNodeData$SourceType' => 'The source type to specify whether a specific table is the source or a custom query.
', 'AmazonRedshiftNodeData$TablePrefix' => 'Specifies the prefix to a table.
', 'AmazonRedshiftNodeData$MergeAction' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled.
', 'AmazonRedshiftNodeData$MergeWhenMatched' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
', 'AmazonRedshiftNodeData$MergeWhenNotMatched' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn\'t match a new record.
', 'DQResultsPublishingOptions$EvaluationContext' => 'The context of the evaluation.
', 'Datatype$Id' => 'The datatype of the value.
', 'Datatype$Label' => 'A label assigned to the datatype.
', 'LimitedStringList$member' => NULL, 'SnowflakeNodeData$SourceType' => 'Specifies how retrieved data is specified. Valid values: "table", "query".
Specifies a merge action. Valid values: simple, custom. If simple, merge behavior is defined by MergeWhenMatched and MergeWhenNotMatched. If custom, defined by MergeClause.
Specifies how to resolve records that match preexisting data when merging. Valid values: update, delete.
Specifies how to process records that do not match preexisting data when merging. Valid values: insert, none.
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
', 'CreateJobRequest$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'CreateJobRequest$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'Job$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'Job$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'JobRun$Arguments' => 'The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'JobUpdate$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'JobUpdate$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'StartJobRunRequest$Arguments' => 'The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', ], ], 'GenericString' => [ 'base' => NULL, 'refs' => [ 'AdditionalPlanOptionsMap$key' => NULL, 'AdditionalPlanOptionsMap$value' => NULL, 'AmazonRedshiftAdvancedOption$Key' => 'The key for the additional connection option.
', 'AmazonRedshiftAdvancedOption$Value' => 'The value for the additional connection option.
', 'AmazonRedshiftNodeData$CatalogRedshiftSchema' => 'The Redshift schema name when working with a data catalog.
', 'AmazonRedshiftNodeData$CatalogRedshiftTable' => 'The database table to read from.
', 'AmazonRedshiftNodeData$SampleQuery' => 'The SQL used to fetch the data from a Redshift sources when the SourceType is \'query\'.
', 'AmazonRedshiftNodeData$PreAction' => 'The SQL used before a MERGE or APPEND with upsert is run.
', 'AmazonRedshiftNodeData$PostAction' => 'The SQL used before a MERGE or APPEND with upsert is run.
', 'AmazonRedshiftNodeData$Action' => 'Specifies how writing to a Redshift cluser will occur.
', 'AmazonRedshiftNodeData$MergeClause' => 'The SQL used in a custom merge to deal with matching records.
', 'AmazonRedshiftNodeData$CrawlerConnection' => 'Specifies the name of the connection that is associated with the catalog table used.
', 'AmazonRedshiftNodeData$StagingTable' => 'The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
', 'Blueprint$BlueprintLocation' => 'Specifies the path in Amazon S3 where the blueprint is published.
', 'Blueprint$BlueprintServiceLocation' => 'Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.
The value provided for comparison on the crawl field.
', 'CreateDevEndpointRequest$EndpointName' => 'The name to be assigned to the new DevEndpoint.
The subnet ID for the new DevEndpoint to use.
The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
The name assigned to the new DevEndpoint.
The current status of the new DevEndpoint.
The subnet ID assigned to the new DevEndpoint.
The address of the YARN endpoint used by this DevEndpoint.
The Amazon Web Services Availability Zone where this DevEndpoint is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint.
The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint.
Path to one or more Java .jar files in an S3 bucket that will be loaded in your DevEndpoint.
The reason for a current failure in this DevEndpoint.
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
This field is required when the trigger type is SCHEDULED.
', 'CreateWorkflowRequest$Description' => 'A description of the workflow.
', 'DQAdditionalOptions$value' => NULL, 'DataQualityResult$EvaluationContext' => 'In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.
The name of the DevEndpoint.
The name of the DevEndpoint.
The subnet ID for this DevEndpoint.
The YARN endpoint address used by this DevEndpoint.
A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.
The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint.
The current status of this DevEndpoint.
The Amazon Web Services Availability Zone where this DevEndpoint is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint.
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
You can only use pure Java/Scala libraries with a DevEndpoint.
The reason for a current failure in this DevEndpoint.
The status of the last update.
', 'DevEndpoint$PublicKey' => 'The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3) bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
You can only use pure Java/Scala libraries with a DevEndpoint.
A continuation token, if this is a continuation request.
', 'GetBlueprintRunsResponse$NextToken' => 'A continuation token, if not all blueprint runs have been returned.
', 'GetDataQualityResultResponse$EvaluationContext' => 'In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.
The error strings that are associated with the run.
', 'GetDataQualityRulesetEvaluationRunResponse$ErrorString' => 'The error strings that are associated with the run.
', 'GetDevEndpointRequest$EndpointName' => 'Name of the DevEndpoint to retrieve information for.
A continuation token, if this is a continuation call.
', 'GetDevEndpointsResponse$NextToken' => 'A continuation token, if not all DevEndpoint definitions have yet been returned.
A continuation token, if this is a continuation call.
', 'GetJobRunsResponse$NextToken' => 'A continuation token, if not all requested job runs have been returned.
', 'GetJobsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetJobsResponse$NextToken' => 'A continuation token, if not all job definitions have yet been returned.
', 'GetMLTaskRunResponse$LogGroupName' => 'The names of the log groups that are associated with the task run.
', 'GetMLTaskRunResponse$ErrorString' => 'The error strings that are associated with the task run.
', 'GetSecurityConfigurationsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetSecurityConfigurationsResponse$NextToken' => 'A continuation token, if there are more security configurations to return.
', 'GetTriggersRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetTriggersResponse$NextToken' => 'A continuation token, if not all the requested triggers have yet been returned.
', 'GetWorkflowRunsRequest$NextToken' => 'The maximum size of the response.
', 'GetWorkflowRunsResponse$NextToken' => 'A continuation token, if not all requested workflow runs have been returned.
', 'JobCommand$Name' => 'The name of the job command. For an Apache Spark ETL job, this must be glueetl. For a Python shell job, it must be pythonshell. For an Apache Spark streaming ETL job, this must be gluestreaming. For a Ray job, this must be glueray.
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration is used to encrypt the log group.
Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.
', 'LastActiveDefinition$BlueprintServiceLocation' => 'Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.
', 'ListBlueprintsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListBlueprintsResponse$NextToken' => 'A continuation token, if not all blueprint names have been returned.
', 'ListDevEndpointsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListDevEndpointsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListJobsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListJobsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListTriggersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListTriggersResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListWorkflowsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListWorkflowsResponse$NextToken' => 'A continuation token, if not all workflow names have been returned.
', 'MapValue$key' => NULL, 'MapValue$value' => NULL, 'OrchestrationStringList$member' => NULL, 'PublicKeysList$member' => NULL, 'SnowflakeNodeData$Schema' => 'Specifies a Snowflake database schema for your node to use.
', 'SnowflakeNodeData$Table' => 'Specifies a Snowflake table for your node to use.
', 'SnowflakeNodeData$Database' => 'Specifies a Snowflake database for your node to use.
', 'SnowflakeNodeData$SampleQuery' => 'A SQL string used to retrieve data with the query sourcetype.
A SQL string run before the Snowflake connector performs its standard actions.
', 'SnowflakeNodeData$PostAction' => 'A SQL string run after the Snowflake connector performs its standard actions.
', 'SnowflakeNodeData$Action' => 'Specifies what action to take when writing to a table with preexisting data. Valid values: append, merge, truncate, drop.
A SQL statement that specifies a custom merge behavior.
', 'SnowflakeNodeData$StagingTable' => 'The name of a staging table used when performing merge or upsert append actions. Data is written to this table, then moved to table by a generated postaction.
The execution code of the statement.
', 'StatementOutput$ErrorName' => 'The name of the error in the output.
', 'StatementOutput$ErrorValue' => 'The error value of the output.
', 'StatementOutputData$TextPlain' => 'The code execution output in text format.
', 'StringList$member' => NULL, 'TaskRun$LogGroupName' => 'The names of the log group for secure logging, associated with this task run.
', 'TaskRun$ErrorString' => 'The list of error strings associated with this task run.
', 'Trigger$Schedule' => 'A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
The name of the DevEndpoint to be updated.
The public key for the DevEndpoint to use.
The description of the workflow.
', 'Workflow$Description' => 'A description of the workflow.
', 'WorkflowRunProperties$value' => NULL, ], ], 'GetBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCatalogImportStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCatalogImportStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifiersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifiersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionRequest$ColumnNames' => 'A list of the column names.
', 'GetColumnStatisticsForTableRequest$ColumnNames' => 'A list of the column names.
', ], ], 'GetColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsFilter' => [ 'base' => 'Filters the connection definitions that are returned by the GetConnections API operation.
A filter that controls which connections are returned.
', ], ], 'GetConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomEntityTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomEntityTypeResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataCatalogEncryptionSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataCatalogEncryptionSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataflowGraphRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataflowGraphResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobBookmarkRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobBookmarkResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMappingResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionIndexesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionIndexesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRegistryInput' => [ 'base' => NULL, 'refs' => [], ], 'GetRegistryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesResponseList' => [ 'base' => NULL, 'refs' => [ 'GetResourcePoliciesResponse$GetResourcePoliciesResponseList' => 'A list of the individual resource policies and the account-level resource policy.
', ], ], 'GetResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaByDefinitionInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaByDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionsDiffInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionsDiffResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetTableVersionsResponse$TableVersions' => 'A list of strings identifying available versions of the specified table.
', ], ], 'GetTableVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTablesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTablesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionsMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionsMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredTableMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredTableMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GlueEncryptionException' => [ 'base' => 'An encryption operation failed.
', 'refs' => [], ], 'GluePolicy' => [ 'base' => 'A structure for returning a resource policy.
', 'refs' => [ 'GetResourcePoliciesResponseList$member' => NULL, ], ], 'GlueRecordType' => [ 'base' => NULL, 'refs' => [ 'JDBCDataTypeMapping$value' => NULL, ], ], 'GlueResourceArn' => [ 'base' => NULL, 'refs' => [ 'CreateRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the newly created registry.
', 'CreateSchemaResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'CreateSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'DeleteRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry being deleted.
', 'DeleteResourcePolicyRequest$ResourceArn' => 'The ARN of the Glue resource for the resource policy to be deleted.
', 'DeleteSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema being deleted.
', 'FederatedResourceAlreadyExistsException$AssociatedGlueResource' => 'The associated Glue resource already exists.
', 'GetRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'GetResourcePolicyRequest$ResourceArn' => 'The ARN of the Glue resource for which to retrieve the resource policy. If not supplied, the Data Catalog resource policy is returned. Use GetResourcePolicies to view all existing resource policies. For more information see Specifying Glue Resource ARNs.
The Amazon Resource Name (ARN) of the schema.
', 'GetSchemaResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'GetSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'GetSchemaVersionResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'GetTagsRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
', 'PutResourcePolicyRequest$ResourceArn' => 'Do not use. For internal use only.
', 'PutSchemaVersionMetadataResponse$SchemaArn' => 'The Amazon Resource Name (ARN) for the schema.
', 'RegistryId$RegistryArn' => 'Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.
The Amazon Resource Name (ARN) of the registry.
', 'RemoveSchemaVersionMetadataResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'SchemaId$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The Amazon Resource Name (ARN) for the schema.
', 'SchemaVersionListItem$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'TagResourceRequest$ResourceArn' => 'The ARN of the Glue resource to which to add the tags. For more information about Glue resource ARNs, see the Glue ARN string pattern.
', 'UntagResourceRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource from which to remove the tags.
', 'UpdateRegistryResponse$RegistryArn' => 'The Amazon Resource name (ARN) of the updated registry.
', 'UpdateSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', ], ], 'GlueSchema' => [ 'base' => 'Specifies a user-defined schema when a schema cannot be determined by Glue.
', 'refs' => [ 'GlueSchemas$member' => NULL, ], ], 'GlueSchemas' => [ 'base' => NULL, 'refs' => [ 'AthenaConnectorSource$OutputSchemas' => 'Specifies the data schema for the custom Athena source.
', 'CatalogDeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'CatalogHudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'CustomCode$OutputSchemas' => 'Specifies the data schema for the custom code transform.
', 'DynamicTransform$OutputSchemas' => 'Specifies the data schema for the dynamic transform.
', 'JDBCConnectorSource$OutputSchemas' => 'Specifies the data schema for the custom JDBC source.
', 'JDBCConnectorTarget$OutputSchemas' => 'Specifies the data schema for the JDBC target.
', 'S3CatalogDeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'S3CatalogHudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'S3CsvSource$OutputSchemas' => 'Specifies the data schema for the S3 CSV source.
', 'S3DeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'S3HudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'S3JsonSource$OutputSchemas' => 'Specifies the data schema for the S3 JSON source.
', 'S3ParquetSource$OutputSchemas' => 'Specifies the data schema for the S3 Parquet source.
', 'SnowflakeSource$OutputSchemas' => 'Specifies user-defined schemas for your output data.
', 'SparkConnectorSource$OutputSchemas' => 'Specifies data schema for the custom spark source.
', 'SparkConnectorTarget$OutputSchemas' => 'Specifies the data schema for the custom spark target.
', 'SparkSQL$OutputSchemas' => 'Specifies the data schema for the SparkSQL transform.
', ], ], 'GlueStudioColumnNameString' => [ 'base' => NULL, 'refs' => [ 'GlueStudioSchemaColumn$Name' => 'The name of the column in the Glue Studio schema.
', ], ], 'GlueStudioPathList' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Groups' => 'Specifies the fields to group by.
', 'DropFields$Paths' => 'A JSON path to a variable in the data structure.
', 'GovernedCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'JoinColumn$Keys' => 'The key of the column to be joined.
', 'Merge$PrimaryKeys' => 'The list of primary key fields to match records from the source and staging dynamic frames.
', 'S3CatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DeltaCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DeltaDirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3GlueParquetTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3HudiCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3HudiDirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'SelectFields$Paths' => 'A JSON path to a variable in the data structure.
', 'SplitFields$Paths' => 'A JSON path to a variable in the data structure.
', ], ], 'GlueStudioSchemaColumn' => [ 'base' => 'Specifies a single column in a Glue schema definition.
', 'refs' => [ 'GlueStudioSchemaColumnList$member' => NULL, ], ], 'GlueStudioSchemaColumnList' => [ 'base' => NULL, 'refs' => [ 'GlueSchema$Columns' => 'Specifies the column definitions that make up a Glue schema.
', ], ], 'GlueTable' => [ 'base' => 'The database and table in the Glue Data Catalog that is used for input or output data.
', 'refs' => [ 'DataSource$GlueTable' => 'An Glue table.
', 'GlueTables$member' => NULL, ], ], 'GlueTableAdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'GlueTable$AdditionalOptions' => 'Additional options for the table. Currently there are two keys supported:
pushDownPredicate: to filter on partitions without having to list and read all the files in your dataset.
catalogPartitionPredicate: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
A list of Glue table definitions used by the transform.
', 'GetMLTransformResponse$InputRecordTables' => 'A list of Glue table definitions used by the transform.
', 'MLTransform$InputRecordTables' => 'A list of Glue table definitions used by the transform.
', ], ], 'GlueVersionString' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$GlueVersion' => 'Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
', 'CreateJobRequest$GlueVersion' => 'In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'CreateMLTransformRequest$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'CreateSessionRequest$GlueVersion' => 'The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
', 'DevEndpoint$GlueVersion' => 'Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'Job$GlueVersion' => 'In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'JobRun$GlueVersion' => 'In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'JobUpdate$GlueVersion' => 'In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'MLTransform$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'Session$GlueVersion' => 'The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
', 'TransformFilterCriteria$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'UpdateMLTransformRequest$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', ], ], 'GovernedCatalogSource' => [ 'base' => 'Specifies the data store in the governed Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$GovernedCatalogSource' => 'Specifies a data source in a goverened Data Catalog.
', ], ], 'GovernedCatalogTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$GovernedCatalogTarget' => 'Specifies a data target that writes to a goverened catalog.
', ], ], 'GrokClassifier' => [ 'base' => 'A classifier that uses grok patterns.
A classifier that uses grok.
The grok pattern used by this classifier.
', 'GrokClassifier$GrokPattern' => 'The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.
', 'UpdateGrokClassifierRequest$GrokPattern' => 'The grok pattern used by this classifier.
', ], ], 'HashString' => [ 'base' => NULL, 'refs' => [ 'CancelDataQualityRuleRecommendationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'CancelDataQualityRulesetEvaluationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'CancelMLTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'CancelMLTaskRunRequest$TaskRunId' => 'A unique identifier for the task run.
', 'CancelMLTaskRunResponse$TransformId' => 'The unique identifier of the machine learning transform.
', 'CancelMLTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'CreateDataQualityRulesetRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'CreateMLTransformResponse$TransformId' => 'A unique identifier that is generated for the transform.
', 'DataQualityResult$ResultId' => 'A unique result ID for the data quality result.
', 'DataQualityResult$JobRunId' => 'The job run ID associated with the data quality result, if any.
', 'DataQualityResult$RulesetEvaluationRunId' => 'The unique run ID for the ruleset evaluation for this data quality result.
', 'DataQualityResultDescription$ResultId' => 'The unique result ID for this data quality result.
', 'DataQualityResultDescription$JobRunId' => 'The job run ID associated with the data quality result.
', 'DataQualityResultFilterCriteria$JobRunId' => 'Filter results by the specified job run ID.
', 'DataQualityResultIdList$member' => NULL, 'DataQualityResultIds$member' => NULL, 'DataQualityRuleRecommendationRunDescription$RunId' => 'The unique run identifier associated with this run.
', 'DataQualityRulesetEvaluationRunDescription$RunId' => 'The unique run identifier associated with this run.
', 'DataQualityRulesetListDetails$RecommendationRunId' => 'When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
', 'DeleteMLTransformRequest$TransformId' => 'The unique identifier of the transform to delete.
', 'DeleteMLTransformResponse$TransformId' => 'The unique identifier of the transform that was deleted.
', 'DeleteResourcePolicyRequest$PolicyHashCondition' => 'The hash value returned when this policy was set.
', 'FindMatchesTaskRunProperties$JobId' => 'The job ID for the Find Matches task run.
', 'FindMatchesTaskRunProperties$JobRunId' => 'The job run ID for the Find Matches task run.
', 'GetDataQualityResultRequest$ResultId' => 'A unique result ID for the data quality result.
', 'GetDataQualityResultResponse$ResultId' => 'A unique result ID for the data quality result.
', 'GetDataQualityResultResponse$JobRunId' => 'The job run ID associated with the data quality result, if any.
', 'GetDataQualityResultResponse$RulesetEvaluationRunId' => 'The unique run ID associated with the ruleset evaluation.
', 'GetDataQualityRuleRecommendationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRuleRecommendationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetEvaluationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetEvaluationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetResponse$RecommendationRunId' => 'When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
', 'GetMLTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'GetMLTaskRunRequest$TaskRunId' => 'The unique identifier of the task run.
', 'GetMLTaskRunResponse$TransformId' => 'The unique identifier of the task run.
', 'GetMLTaskRunResponse$TaskRunId' => 'The unique run identifier associated with this run.
', 'GetMLTaskRunsRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'GetMLTransformRequest$TransformId' => 'The unique identifier of the transform, generated at the time that the transform was created.
', 'GetMLTransformResponse$TransformId' => 'The unique identifier of the transform, generated at the time that the transform was created.
', 'GetResourcePolicyResponse$PolicyHash' => 'Contains the hash value associated with this policy.
', 'GluePolicy$PolicyHash' => 'Contains the hash value associated with this policy.
', 'MLTransform$TransformId' => 'The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
', 'PutResourcePolicyRequest$PolicyHashCondition' => 'The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.
A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.
', 'StartDataQualityRuleRecommendationRunRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'StartDataQualityRuleRecommendationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'StartDataQualityRulesetEvaluationRunRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'StartDataQualityRulesetEvaluationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'StartExportLabelsTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartExportLabelsTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'StartImportLabelsTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartImportLabelsTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'StartMLEvaluationTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartMLEvaluationTaskRunResponse$TaskRunId' => 'The unique identifier associated with this run.
', 'StartMLLabelingSetGenerationTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartMLLabelingSetGenerationTaskRunResponse$TaskRunId' => 'The unique run identifier that is associated with this task run.
', 'TaskRun$TransformId' => 'The unique identifier for the transform.
', 'TaskRun$TaskRunId' => 'The unique identifier for this task run.
', 'TransformIdList$member' => NULL, 'UpdateMLTransformRequest$TransformId' => 'A unique identifier that was generated when the transform was created.
', 'UpdateMLTransformResponse$TransformId' => 'The unique identifier for the transform that was updated.
', ], ], 'HudiTarget' => [ 'base' => 'Specifies an Apache Hudi data source.
', 'refs' => [ 'HudiTargetList$member' => NULL, ], ], 'HudiTargetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3HudiDirectTarget$Compression' => '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 Apache Hudi data store targets.
', ], ], 'IcebergInput' => [ 'base' => 'A structure that defines an Apache Iceberg metadata table to create in the catalog.
', 'refs' => [ 'OpenTableFormatInput$IcebergInput' => 'Specifies an IcebergInput structure that defines an Apache Iceberg metadata table.
Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
', 'refs' => [ 'IcebergTargetList$member' => NULL, ], ], 'IcebergTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$IcebergTargets' => 'Specifies Apache Iceberg data store targets.
', ], ], 'IdString' => [ 'base' => NULL, 'refs' => [ 'BatchStopJobRunError$JobRunId' => 'The JobRunId of the job run in question.
The JobRunId of the job run that was stopped.
The run ID for this blueprint.
', 'BlueprintRun$RunId' => 'The run ID for this blueprint run.
', 'GetBlueprintRunRequest$RunId' => 'The run ID for the blueprint run you want to retrieve.
', 'GetJobRunRequest$RunId' => 'The ID of the job run.
', 'GetWorkflowRunPropertiesRequest$RunId' => 'The ID of the workflow run whose run properties should be returned.
', 'GetWorkflowRunRequest$RunId' => 'The ID of the workflow run.
', 'JobRun$Id' => 'The ID of this job run.
', 'JobRun$PreviousRunId' => 'The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
The job-run ID of the predecessor job run.
', 'PutWorkflowRunPropertiesRequest$RunId' => 'The ID of the workflow run for which the run properties should be updated.
', 'ResumeWorkflowRunRequest$RunId' => 'The ID of the workflow run to resume.
', 'ResumeWorkflowRunResponse$RunId' => 'The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
', 'StartBlueprintRunResponse$RunId' => 'The run ID for this blueprint run.
', 'StartJobRunRequest$JobRunId' => 'The ID of a previous JobRun to retry.
The ID assigned to this job run.
', 'StartWorkflowRunResponse$RunId' => 'An Id for the new run.
', 'StopWorkflowRunRequest$RunId' => 'The ID of the workflow run to stop.
', 'Trigger$Id' => 'Reserved for future use.
', 'WorkflowRun$WorkflowRunId' => 'The ID of this workflow run.
', 'WorkflowRun$PreviousRunId' => 'The ID of the previous workflow run.
', 'WorkflowRunProperties$key' => NULL, ], ], 'IdempotentParameterMismatchException' => [ 'base' => 'The same unique identifier was associated with two different records.
', 'refs' => [], ], 'IllegalBlueprintStateException' => [ 'base' => 'The blueprint is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'IllegalSessionStateException' => [ 'base' => 'The session is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'IllegalWorkflowStateException' => [ 'base' => 'The workflow is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'ImportCatalogToGlueRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportCatalogToGlueResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportLabelsTaskRunProperties' => [ 'base' => 'Specifies configuration properties for an importing labels task run.
', 'refs' => [ 'TaskRunProperties$ImportLabelsTaskRunProperties' => 'The configuration properties for an importing labels task run.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$LineNumber' => 'The line number of the node.
', 'DecimalNumber$Scale' => 'The scale that determines where the decimal point falls in the unscaled value.
', 'StorageDescriptor$NumberOfBuckets' => 'Must be specified if the table contains any dimension columns.
', ], ], 'IntegerFlag' => [ 'base' => NULL, 'refs' => [ 'Order$SortOrder' => 'Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).
The ID of the statement to be cancelled.
', 'CreateDevEndpointRequest$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) to allocate to this DevEndpoint.
The Apache Zeppelin port for the remote Apache Spark interpreter.
', 'CreateDevEndpointResponse$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
', 'CreateJobRequest$AllocatedCapacity' => 'This parameter is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'DevEndpoint$ZeppelinRemoteSparkInterpreterPort' => 'The Apache Zeppelin port for the remote Apache Spark interpreter.
', 'DevEndpoint$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
The Id of the statement.
', 'Job$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'JobBookmarkEntry$Version' => 'The version of the job.
', 'JobBookmarkEntry$Run' => 'The run ID number.
', 'JobBookmarkEntry$Attempt' => 'The attempt ID number.
', 'JobRun$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'JobUpdate$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'RunStatementResponse$Id' => 'Returns the Id of the statement that was run.
', 'StartJobRunRequest$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'Statement$Id' => 'The ID of the statement.
', 'StatementOutput$ExecutionCount' => 'The execution count of the output.
', 'WorkflowRunStatistics$TotalActions' => 'Total number of Actions in the workflow run.
', 'WorkflowRunStatistics$TimeoutActions' => 'Total number of Actions that timed out.
', 'WorkflowRunStatistics$FailedActions' => 'Total number of Actions that have failed.
', 'WorkflowRunStatistics$StoppedActions' => 'Total number of Actions that have stopped.
', 'WorkflowRunStatistics$SucceededActions' => 'Total number of Actions that have succeeded.
', 'WorkflowRunStatistics$RunningActions' => 'Total number Actions in running state.
', 'WorkflowRunStatistics$ErroredActions' => 'Indicates the count of job runs in the ERROR state in the workflow run.
', 'WorkflowRunStatistics$WaitingActions' => 'Indicates the count of job runs in WAITING state in the workflow run.
', ], ], 'InternalServiceException' => [ 'base' => 'An internal service error occurred.
', 'refs' => [], ], 'InvalidInputException' => [ 'base' => 'The input provided was not valid.
', 'refs' => [], ], 'InvalidStateException' => [ 'base' => 'An error that indicates your data is in an invalid state.
', 'refs' => [], ], 'IsVersionValid' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityResponse$Valid' => 'Return true, if the schema is valid and false otherwise.
', ], ], 'Iso8601DateTime' => [ 'base' => NULL, 'refs' => [ 'KafkaStreamingSourceOptions$StartingTimestamp' => 'The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
Only one of StartingTimestamp or StartingOffsets must be set.
The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
The connection type of the JDBC source.
', ], ], 'JDBCConnectorOptions' => [ 'base' => 'Additional connection options for the connector.
', 'refs' => [ 'JDBCConnectorSource$AdditionalOptions' => 'Additional connection options for the connector.
', ], ], 'JDBCConnectorSource' => [ 'base' => 'Specifies a connector to a JDBC data source.
', 'refs' => [ 'CodeGenConfigurationNode$JDBCConnectorSource' => 'Specifies a connector to a JDBC data source.
', ], ], 'JDBCConnectorTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', 'refs' => [ 'CodeGenConfigurationNode$JDBCConnectorTarget' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', ], ], 'JDBCDataType' => [ 'base' => NULL, 'refs' => [ 'JDBCDataTypeMapping$key' => NULL, ], ], 'JDBCDataTypeMapping' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorOptions$DataTypeMapping' => 'Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"} maps data fields of JDBC type FLOAT into the Java String type by calling the ResultSet.getString() method of the driver, and uses it to build the Glue record. The ResultSet object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
Specifies a JDBC data store to crawl.
', 'refs' => [ 'JdbcTargetList$member' => NULL, ], ], 'JdbcTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$JdbcTargets' => 'Specifies JDBC targets.
', ], ], 'Job' => [ 'base' => 'Specifies a job definition.
', 'refs' => [ 'GetJobResponse$Job' => 'The requested job definition.
', 'JobList$member' => NULL, ], ], 'JobBookmarkEntry' => [ 'base' => 'Defines a point that a job can resume processing.
', 'refs' => [ 'GetJobBookmarkResponse$JobBookmarkEntry' => 'A structure that defines a point that a job can resume processing.
', 'ResetJobBookmarkResponse$JobBookmarkEntry' => 'The reset bookmark entry.
', ], ], 'JobBookmarksEncryption' => [ 'base' => 'Specifies how job bookmark data should be encrypted.
', 'refs' => [ 'EncryptionConfiguration$JobBookmarksEncryption' => 'The encryption configuration for job bookmarks.
', ], ], 'JobBookmarksEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'JobBookmarksEncryption$JobBookmarksEncryptionMode' => 'The encryption mode to use for job bookmarks data.
', ], ], 'JobCommand' => [ 'base' => 'Specifies code that runs when a job is run.
', 'refs' => [ 'CreateJobRequest$Command' => 'The JobCommand that runs this job.
The JobCommand that runs this job.
The JobCommand that runs this job (required).
A list of job definitions.
', 'GetJobsResponse$Jobs' => 'A list of job definitions.
', ], ], 'JobName' => [ 'base' => NULL, 'refs' => [ 'GetJobBookmarkRequest$JobName' => 'The name of the job in question.
', 'JobBookmarkEntry$JobName' => 'The name of the job in question.
', 'ResetJobBookmarkRequest$JobName' => 'The name of the job in question.
', ], ], 'JobNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetJobsRequest$JobNames' => 'A list of job names, which might be the names returned from the ListJobs operation.
A list of names of jobs not found.
', 'ListJobsResponse$JobNames' => 'The names of all jobs in the account, or the jobs with the specified tags.
', ], ], 'JobNodeDetails' => [ 'base' => 'The details of a Job node present in the workflow.
', 'refs' => [ 'Node$JobDetails' => 'Details of the Job when the node represents a Job.
', ], ], 'JobRun' => [ 'base' => 'Contains information about a job run.
', 'refs' => [ 'GetJobRunResponse$JobRun' => 'The requested job-run metadata.
', 'JobRunList$member' => NULL, ], ], 'JobRunList' => [ 'base' => NULL, 'refs' => [ 'GetJobRunsResponse$JobRuns' => 'A list of job-run metadata objects.
', 'JobNodeDetails$JobRuns' => 'The information for the job runs represented by the job node.
', ], ], 'JobRunState' => [ 'base' => NULL, 'refs' => [ 'Condition$State' => 'The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED, STOPPED, FAILED, and TIMEOUT. The only crawler states that a trigger can listen for are SUCCEEDED, FAILED, and CANCELLED.
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
', ], ], 'JobUpdate' => [ 'base' => 'Specifies information used to update an existing job definition. The previous job definition is completely overwritten by this information.
', 'refs' => [ 'UpdateJobRequest$JobUpdate' => 'Specifies the values with which to update the job definition. Unspecified configuration is removed or reset to default values.
', ], ], 'Join' => [ 'base' => 'Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
', 'refs' => [ 'CodeGenConfigurationNode$Join' => 'Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
', ], ], 'JoinColumn' => [ 'base' => 'Specifies a column to be joined.
', 'refs' => [ 'JoinColumns$member' => NULL, ], ], 'JoinColumns' => [ 'base' => NULL, 'refs' => [ 'Join$Columns' => 'A list of the two columns to be joined.
', ], ], 'JoinType' => [ 'base' => NULL, 'refs' => [ 'Join$JoinType' => 'Specifies the type of join to be performed on the datasets.
', ], ], 'JsonClassifier' => [ 'base' => 'A classifier for JSON content.
A classifier for JSON content.
', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'CreateJsonClassifierRequest$JsonPath' => 'A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
The bookmark itself.
', ], ], 'KafkaStreamingSourceOptions' => [ 'base' => 'Additional options for streaming.
', 'refs' => [ 'CatalogKafkaSource$StreamingOptions' => 'Specifies the streaming options.
', 'DirectKafkaSource$StreamingOptions' => 'Specifies the streaming options.
', ], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'PartitionIndex$Keys' => 'The keys for the partition index.
', ], ], 'KeySchemaElement' => [ 'base' => 'A partition key pair consisting of a name and a type.
', 'refs' => [ 'KeySchemaElementList$member' => NULL, ], ], 'KeySchemaElementList' => [ 'base' => NULL, 'refs' => [ 'PartitionIndexDescriptor$Keys' => 'A list of one or more keys, as KeySchemaElement structures, for the partition index.
Additional options for the Amazon Kinesis streaming data source.
', 'refs' => [ 'CatalogKinesisSource$StreamingOptions' => 'Additional options for the Kinesis streaming data source.
', 'DirectKinesisSource$StreamingOptions' => 'Additional options for the Kinesis streaming data source.
', ], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEncryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', 'JobBookmarksEncryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', 'S3Encryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', ], ], 'LabelCount' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformResponse$LabelCount' => 'The number of labels available for this transform.
', 'MLTransform$LabelCount' => 'A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
', ], ], 'LabelingSetGenerationTaskRunProperties' => [ 'base' => 'Specifies configuration properties for a labeling set generation task run.
', 'refs' => [ 'TaskRunProperties$LabelingSetGenerationTaskRunProperties' => 'The configuration properties for a labeling set generation task run.
', ], ], 'LakeFormationConfiguration' => [ 'base' => 'Specifies Lake Formation configuration settings for the crawler.
', 'refs' => [ 'Crawler$LakeFormationConfiguration' => 'Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
', 'CreateCrawlerRequest$LakeFormationConfiguration' => 'Specifies Lake Formation configuration settings for the crawler.
', 'UpdateCrawlerRequest$LakeFormationConfiguration' => 'Specifies Lake Formation configuration settings for the crawler.
', ], ], 'Language' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$Language' => 'The programming language of the resulting code from the DAG.
', 'GetPlanRequest$Language' => 'The programming language of the code to perform the mapping.
', ], ], 'LastActiveDefinition' => [ 'base' => 'When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
', 'refs' => [ 'Blueprint$LastActiveDefinition' => 'When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
', ], ], 'LastCrawlInfo' => [ 'base' => 'Status and error information about the most recent crawl.
', 'refs' => [ 'Crawler$LastCrawl' => 'The status of the last crawl, and potentially error information if an error occurred.
', ], ], 'LastCrawlStatus' => [ 'base' => NULL, 'refs' => [ 'LastCrawlInfo$Status' => 'Status of the last crawl.
', ], ], 'LatestSchemaVersionBoolean' => [ 'base' => NULL, 'refs' => [ 'PutSchemaVersionMetadataResponse$LatestVersion' => 'The latest version of the schema.
', 'RemoveSchemaVersionMetadataResponse$LatestVersion' => 'The latest version of the schema.
', 'SchemaVersionNumber$LatestVersion' => 'The latest version available for the schema.
', ], ], 'LimitedPathList' => [ 'base' => NULL, 'refs' => [ 'DropDuplicates$Columns' => 'The name of the columns to be merged or removed if repeating.
', ], ], 'LimitedStringList' => [ 'base' => NULL, 'refs' => [ 'LimitedPathList$member' => NULL, ], ], 'LineageConfiguration' => [ 'base' => 'Specifies data lineage configuration settings for the crawler.
', 'refs' => [ 'Crawler$LineageConfiguration' => 'A configuration that specifies whether data lineage is enabled for the crawler.
', 'CreateCrawlerRequest$LineageConfiguration' => 'Specifies data lineage configuration settings for the crawler.
', 'UpdateCrawlerRequest$LineageConfiguration' => 'Specifies data lineage configuration settings for the crawler.
', ], ], 'ListBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomEntityTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomEntityTypesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityResultsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityResultsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRuleRecommendationRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRuleRecommendationRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetEvaluationRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetEvaluationRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMLTransformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMLTransformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSessionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSessionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStatementsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStatementsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => 'The location of resources.
', 'refs' => [ 'GetMappingRequest$Location' => 'Parameters for the mapping.
', 'GetPlanRequest$Location' => 'The parameters for the mapping.
', ], ], 'LocationMap' => [ 'base' => NULL, 'refs' => [ 'SkewedInfo$SkewedColumnValueLocationMaps' => 'A mapping of skewed values to the columns that contain them.
', ], ], 'LocationString' => [ 'base' => NULL, 'refs' => [ 'LocationStringList$member' => NULL, 'StorageDescriptor$Location' => 'The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
', ], ], 'LocationStringList' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$AdditionalLocations' => 'A list of locations that point to the path where a Delta table is located.
', ], ], 'LogGroup' => [ 'base' => NULL, 'refs' => [ 'Crawl$LogGroup' => 'The log group associated with the crawl.
', 'CrawlerHistory$LogGroup' => 'The log group associated with the crawl.
', 'LastCrawlInfo$LogGroup' => 'The log group for the last crawl.
', ], ], 'LogStream' => [ 'base' => NULL, 'refs' => [ 'Crawl$LogStream' => 'The log stream associated with the crawl.
', 'CrawlerHistory$LogStream' => 'The log stream associated with the crawl.
', 'LastCrawlInfo$LogStream' => 'The log stream for the last crawl.
', ], ], 'Logical' => [ 'base' => NULL, 'refs' => [ 'Predicate$Logical' => 'An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
', ], ], 'LogicalOperator' => [ 'base' => NULL, 'refs' => [ 'Condition$LogicalOperator' => 'A logical operator.
', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'LongColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'LongColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'LongColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for integer data columns.
', 'refs' => [ 'ColumnStatisticsData$LongColumnStatisticsData' => 'Long column statistics data.
', ], ], 'LongValue' => [ 'base' => NULL, 'refs' => [ 'Statement$StartedOn' => 'The unix time and date that the job definition was started.
', 'Statement$CompletedOn' => 'The unix time and date that the job definition was completed.
', ], ], 'MLTransform' => [ 'base' => 'A structure for a machine learning transform.
', 'refs' => [ 'TransformList$member' => NULL, ], ], 'MLTransformNotReadyException' => [ 'base' => 'The machine learning transform is not ready to run.
', 'refs' => [], ], 'MLUserDataEncryption' => [ 'base' => 'The encryption-at-rest settings of the transform that apply to accessing user data.
', 'refs' => [ 'TransformEncryption$MlUserDataEncryption' => 'An MLUserDataEncryption object containing the encryption mode and customer-provided KMS key ID.
The encryption mode applied to user data. Valid values are:
DISABLED: encryption is disabled
SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
The data inputs identified by their node names.
', 'EvaluateDataQualityMultiFrame$Inputs' => 'The inputs of your data quality evaluation. The first input in this list is the primary data source.
', 'SparkSQL$Inputs' => 'The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
', ], ], 'MapValue' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$Arguments' => 'A map of arguments used to configure the DevEndpoint.
The map of arguments used to configure this DevEndpoint.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
A map of arguments used to configure the DevEndpoint.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
The map of arguments to add the map of arguments used to configure the DevEndpoint.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
Specifies the mapping of data property keys.
', 'refs' => [ 'Mappings$member' => NULL, ], ], 'MappingEntry' => [ 'base' => 'Defines a mapping.
', 'refs' => [ 'MappingList$member' => NULL, ], ], 'MappingList' => [ 'base' => NULL, 'refs' => [ 'GetMappingResponse$Mapping' => 'A list of mappings to the specified targets.
', 'GetPlanRequest$Mapping' => 'The list of mappings from a source table to target tables.
', ], ], 'Mappings' => [ 'base' => NULL, 'refs' => [ 'ApplyMapping$Mapping' => 'Specifies the mapping of data property keys in the data source to data property keys in the data target.
', 'Mapping$Children' => 'Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping, but its FromPath will be the parent\'s FromPath plus the FromPath from this structure.
For the children part, suppose you have the structure:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
You can specify a Mapping that looks like:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
Indicates the value that will replace the detected entity.
', ], ], 'MatchCriteria' => [ 'base' => NULL, 'refs' => [ 'Connection$MatchCriteria' => 'A list of criteria that can be used in selecting this connection.
', 'ConnectionInput$MatchCriteria' => 'A list of criteria that can be used in selecting this connection.
', 'GetConnectionsFilter$MatchCriteria' => 'A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.
', ], ], 'MaxConcurrentRuns' => [ 'base' => NULL, 'refs' => [ 'ExecutionProperty$MaxConcurrentRuns' => 'The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
', ], ], 'MaxResultsNumber' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', 'ListSchemaVersionsInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', 'ListSchemasInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', ], ], 'MaxRetries' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$MaxRetries' => 'The maximum number of times to retry this job if it fails.
', 'Job$MaxRetries' => 'The maximum number of times to retry this job after a JobRun fails.
', 'JobUpdate$MaxRetries' => 'The maximum number of times to retry this job if it fails.
', ], ], 'Merge' => [ 'base' => 'Specifies a transform that merges a DynamicFrame with a staging DynamicFrame based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
Specifies a transform that merges a DynamicFrame with a staging DynamicFrame based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
The prefix for a CloudWatch message about this crawl.
', 'LastCrawlInfo$MessagePrefix' => 'The prefix for a message about this crawl.
', ], ], 'MessageString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => 'A message describing the problem.
', 'AlreadyExistsException$Message' => 'A message describing the problem.
', 'BlueprintRun$ErrorMessage' => 'Indicates any errors that are seen while running the blueprint.
', 'BlueprintRun$RollbackErrorMessage' => 'If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
', 'ConcurrentModificationException$Message' => 'A message describing the problem.
', 'ConcurrentRunsExceededException$Message' => 'A message describing the problem.
', 'ConditionCheckFailureException$Message' => 'A message describing the problem.
', 'ConflictException$Message' => 'A message describing the problem.
', 'CrawlerNotRunningException$Message' => 'A message describing the problem.
', 'CrawlerRunningException$Message' => 'A message describing the problem.
', 'CrawlerStoppingException$Message' => 'A message describing the problem.
', 'EntityNotFoundException$Message' => 'A message describing the problem.
', 'FederatedResourceAlreadyExistsException$Message' => 'The message describing the problem.
', 'FederationSourceException$Message' => 'The message describing the problem.
', 'FederationSourceRetryableException$Message' => NULL, 'GlueEncryptionException$Message' => 'The message describing the problem.
', 'IdempotentParameterMismatchException$Message' => 'A message describing the problem.
', 'IllegalBlueprintStateException$Message' => 'A message describing the problem.
', 'IllegalSessionStateException$Message' => 'A message describing the problem.
', 'IllegalWorkflowStateException$Message' => 'A message describing the problem.
', 'InternalServiceException$Message' => 'A message describing the problem.
', 'InvalidInputException$Message' => 'A message describing the problem.
', 'InvalidStateException$Message' => 'A message describing the problem.
', 'MLTransformNotReadyException$Message' => 'A message describing the problem.
', 'NoScheduleException$Message' => 'A message describing the problem.
', 'OperationTimeoutException$Message' => 'A message describing the problem.
', 'PermissionTypeMismatchException$Message' => 'There is a mismatch between the SupportedPermissionType used in the query request and the permissions defined on the target table.
', 'ResourceNotReadyException$Message' => 'A message describing the problem.
', 'ResourceNumberLimitExceededException$Message' => 'A message describing the problem.
', 'SchedulerNotRunningException$Message' => 'A message describing the problem.
', 'SchedulerRunningException$Message' => 'A message describing the problem.
', 'SchedulerTransitioningException$Message' => 'A message describing the problem.
', 'ValidationException$Message' => 'A message describing the problem.
', 'VersionMismatchException$Message' => 'A message describing the problem.
', ], ], 'MetadataInfo' => [ 'base' => 'A structure containing metadata information for a schema version.
', 'refs' => [ 'MetadataInfoMap$value' => NULL, ], ], 'MetadataInfoMap' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataResponse$MetadataInfoMap' => 'A map of a metadata key and associated values.
', ], ], 'MetadataKeyString' => [ 'base' => NULL, 'refs' => [ 'MetadataInfoMap$key' => NULL, 'MetadataKeyValuePair$MetadataKey' => 'A metadata key.
', 'PutSchemaVersionMetadataResponse$MetadataKey' => 'The metadata key.
', 'RemoveSchemaVersionMetadataResponse$MetadataKey' => 'The metadata key.
', ], ], 'MetadataKeyValuePair' => [ 'base' => 'A structure containing a key value pair for metadata.
', 'refs' => [ 'MetadataList$member' => NULL, 'PutSchemaVersionMetadataInput$MetadataKeyValue' => 'The metadata key\'s corresponding value.
', 'RemoveSchemaVersionMetadataInput$MetadataKeyValue' => 'The value of the metadata key.
', ], ], 'MetadataList' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataInput$MetadataList' => 'Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
', ], ], 'MetadataOperation' => [ 'base' => NULL, 'refs' => [ 'IcebergInput$MetadataOperation' => 'A required metadata operation. Can only be set to CREATE.
The metadata key’s corresponding value.
', 'MetadataKeyValuePair$MetadataValue' => 'A metadata key’s corresponding value.
', 'OtherMetadataValueListItem$MetadataValue' => 'The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
', 'PutSchemaVersionMetadataResponse$MetadataValue' => 'The value of the metadata key.
', 'RemoveSchemaVersionMetadataResponse$MetadataValue' => 'The value of the metadata key.
', ], ], 'MicrosoftSQLServerCatalogSource' => [ 'base' => 'Specifies a Microsoft SQL server data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$MicrosoftSQLServerCatalogSource' => 'Specifies a Microsoft SQL server data source in the Glue Data Catalog.
', ], ], 'MicrosoftSQLServerCatalogTarget' => [ 'base' => 'Specifies a target that uses Microsoft SQL.
', 'refs' => [ 'CodeGenConfigurationNode$MicrosoftSQLServerCatalogTarget' => 'Specifies a target that uses Microsoft SQL.
', ], ], 'MillisecondsCount' => [ 'base' => NULL, 'refs' => [ 'Crawler$CrawlElapsedTime' => 'If the crawler is running, contains the total time elapsed since the last crawl began.
', ], ], 'MongoDBTarget' => [ 'base' => 'Specifies an Amazon DocumentDB or MongoDB data store to crawl.
', 'refs' => [ 'MongoDBTargetList$member' => NULL, ], ], 'MongoDBTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$MongoDBTargets' => 'Specifies Amazon DocumentDB or MongoDB targets.
', ], ], 'MySQLCatalogSource' => [ 'base' => 'Specifies a MySQL data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$MySQLCatalogSource' => 'Specifies a MySQL data source in the Glue Data Catalog.
', ], ], 'MySQLCatalogTarget' => [ 'base' => 'Specifies a target that uses MySQL.
', 'refs' => [ 'CodeGenConfigurationNode$MySQLCatalogTarget' => 'Specifies a target that uses MySQL.
', ], ], 'NameString' => [ 'base' => NULL, 'refs' => [ 'Action$JobName' => 'The name of a job to be run.
', 'Action$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this action.
The name of the crawler to be used with this action.
', 'BatchCreatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be created.
', 'BatchCreatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be created.
', 'BatchDeletePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'BatchDeletePartitionRequest$TableName' => 'The name of the table that contains the partitions to be deleted.
', 'BatchDeleteTableNameList$member' => NULL, 'BatchDeleteTableRequest$DatabaseName' => 'The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.
', 'BatchDeleteTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'BatchDeleteTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'BatchGetPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'BatchGetPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'BatchStopJobRunError$JobName' => 'The name of the job definition that is used in the job run in question.
', 'BatchStopJobRunRequest$JobName' => 'The name of the job definition for which to stop job runs.
', 'BatchStopJobRunSuccessfulSubmission$JobName' => 'The name of the job definition used in the job run that was stopped.
', 'BatchUpdatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be updated.
', 'BatchUpdatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be updated.
', 'BlueprintRun$WorkflowName' => 'The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
', 'CancelStatementRequest$SessionId' => 'The Session ID of the statement to be cancelled.
', 'CatalogEntry$DatabaseName' => 'The database in which the table metadata resides.
', 'CatalogEntry$TableName' => 'The name of the table in question.
', 'CatalogImportStatus$ImportedBy' => 'The name of the person who initiated the migration.
', 'CatalogTablesList$member' => NULL, 'CatalogTarget$DatabaseName' => 'The name of the database to be synchronized.
', 'ClassifierNameList$member' => NULL, 'Column$Name' => 'The name of the Column.
The name of the column that failed.
', 'ColumnImportance$ColumnName' => 'The name of a column.
', 'ColumnRowFilter$ColumnName' => 'A string containing the name of the column.
', 'ColumnStatistics$ColumnName' => 'Name of column which statistics belong to.
', 'Condition$JobName' => 'The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
The name of the crawler to which this condition applies.
', 'Connection$Name' => 'The name of the connection definition.
', 'Connection$LastUpdatedBy' => 'The user, group, or role that last updated this connection definition.
', 'ConnectionInput$Name' => 'The name of the connection. Connection will not function as expected without a name.
', 'ConnectionPasswordEncryption$AwsKmsKeyId' => 'An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
', 'ContextWords$member' => NULL, 'Crawler$Name' => 'The name of the crawler.
', 'CrawlerHistory$Summary' => 'A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.
', 'CrawlerMetrics$CrawlerName' => 'The name of the crawler.
', 'CrawlerNameList$member' => NULL, 'CreateBlueprintResponse$Name' => 'Returns the name of the blueprint that was registered.
', 'CreateCrawlerRequest$Name' => 'Name of the new crawler.
', 'CreateCsvClassifierRequest$Name' => 'The name of the classifier.
', 'CreateCustomEntityTypeRequest$Name' => 'A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
', 'CreateCustomEntityTypeRequest$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'CreateCustomEntityTypeResponse$Name' => 'The name of the custom pattern you created.
', 'CreateDataQualityRulesetRequest$Name' => 'A unique name for the data quality ruleset.
', 'CreateDataQualityRulesetResponse$Name' => 'A unique name for the data quality ruleset.
', 'CreateDevEndpointRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this DevEndpoint.
The name of the SecurityConfiguration structure being used with this DevEndpoint.
The name of the new classifier.
', 'CreateJobRequest$Name' => 'The name you assign to this job definition. It must be unique in your account.
', 'CreateJobRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this job.
The unique name that was provided for this job definition.
', 'CreateJsonClassifierRequest$Name' => 'The name of the classifier.
', 'CreateMLTransformRequest$Name' => 'The unique name that you give the transform when you create it.
', 'CreatePartitionIndexRequest$DatabaseName' => 'Specifies the name of a database in which you want to create a partition index.
', 'CreatePartitionIndexRequest$TableName' => 'Specifies the name of a table in which you want to create a partition index.
', 'CreatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be created.
', 'CreatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be created.
', 'CreateSecurityConfigurationRequest$Name' => 'The name for the new security configuration.
', 'CreateSecurityConfigurationResponse$Name' => 'The name assigned to the new security configuration.
', 'CreateSessionRequest$Id' => 'The ID of the session request.
', 'CreateSessionRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with the session
', 'CreateTableRequest$DatabaseName' => 'The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.
', 'CreateTriggerRequest$Name' => 'The name of the trigger.
', 'CreateTriggerRequest$WorkflowName' => 'The name of the workflow associated with the trigger.
', 'CreateTriggerResponse$Name' => 'The name of the trigger.
', 'CreateUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database in which to create the function.
', 'CreateWorkflowRequest$Name' => 'The name to be assigned to the workflow. It should be unique within your account.
', 'CreateWorkflowResponse$Name' => 'The name of the workflow which was provided as part of the request.
', 'CreateXMLClassifierRequest$Name' => 'The name of the classifier.
', 'CsvClassifier$Name' => 'The name of the classifier.
', 'CsvHeader$member' => NULL, 'CustomDatatypes$member' => NULL, 'CustomEntityType$Name' => 'A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
', 'CustomEntityType$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'CustomEntityTypeNames$member' => NULL, 'DataQualityResult$RulesetName' => 'The name of the ruleset associated with the data quality result.
', 'DataQualityResult$JobName' => 'The job name associated with the data quality result, if any.
', 'DataQualityResultDescription$JobName' => 'The job name associated with the data quality result.
', 'DataQualityResultFilterCriteria$JobName' => 'Filter results by the specified job name.
', 'DataQualityRuleResult$Name' => 'The name of the data quality rule.
', 'DataQualityRulesetFilterCriteria$Name' => 'The name of the ruleset filter criteria.
', 'DataQualityRulesetListDetails$Name' => 'The name of the data quality ruleset.
', 'DataQualityTargetTable$TableName' => 'The name of the Glue table.
', 'DataQualityTargetTable$DatabaseName' => 'The name of the database where the Glue table exists.
', 'DataQualityTargetTable$CatalogId' => 'The catalog id where the Glue table exists.
', 'DataSourceMap$key' => NULL, 'Database$Name' => 'The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
', 'DatabaseIdentifier$DatabaseName' => 'The name of the catalog database.
', 'DatabaseIdentifier$Region' => 'Region of the target database.
', 'DatabaseInput$Name' => 'The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
', 'DeleteBlueprintRequest$Name' => 'The name of the blueprint to delete.
', 'DeleteBlueprintResponse$Name' => 'Returns the name of the blueprint that was deleted.
', 'DeleteClassifierRequest$Name' => 'Name of the classifier to remove.
', 'DeleteColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'DeleteColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'DeleteColumnStatisticsForPartitionRequest$ColumnName' => 'Name of the column.
', 'DeleteColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'DeleteColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'DeleteColumnStatisticsForTableRequest$ColumnName' => 'The name of the column.
', 'DeleteConnectionNameList$member' => NULL, 'DeleteConnectionRequest$ConnectionName' => 'The name of the connection to delete.
', 'DeleteCrawlerRequest$Name' => 'The name of the crawler to remove.
', 'DeleteCustomEntityTypeRequest$Name' => 'The name of the custom pattern that you want to delete.
', 'DeleteCustomEntityTypeResponse$Name' => 'The name of the custom pattern you deleted.
', 'DeleteDataQualityRulesetRequest$Name' => 'A name for the data quality ruleset.
', 'DeleteDatabaseRequest$Name' => 'The name of the database to delete. For Hive compatibility, this must be all lowercase.
', 'DeleteJobRequest$JobName' => 'The name of the job definition to delete.
', 'DeleteJobResponse$JobName' => 'The name of the job definition that was deleted.
', 'DeletePartitionIndexRequest$DatabaseName' => 'Specifies the name of a database from which you want to delete a partition index.
', 'DeletePartitionIndexRequest$TableName' => 'Specifies the name of a table from which you want to delete a partition index.
', 'DeletePartitionIndexRequest$IndexName' => 'The name of the partition index to be deleted.
', 'DeletePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'DeletePartitionRequest$TableName' => 'The name of the table that contains the partition to be deleted.
', 'DeleteSecurityConfigurationRequest$Name' => 'The name of the security configuration to delete.
', 'DeleteSessionRequest$Id' => 'The ID of the session to be deleted.
', 'DeleteSessionResponse$Id' => 'Returns the ID of the deleted session.
', 'DeleteTableRequest$DatabaseName' => 'The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableRequest$Name' => 'The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTriggerRequest$Name' => 'The name of the trigger to delete.
', 'DeleteTriggerResponse$Name' => 'The name of the trigger that was deleted.
', 'DeleteUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function is located.
', 'DeleteUserDefinedFunctionRequest$FunctionName' => 'The name of the function definition to be deleted.
', 'DeleteWorkflowRequest$Name' => 'Name of the workflow to be deleted.
', 'DeleteWorkflowResponse$Name' => 'Name of the workflow specified in input.
', 'DevEndpoint$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this DevEndpoint.
The unique of the node within the workflow where the edge starts.
', 'Edge$DestinationId' => 'The unique of the node within the workflow where the edge ends.
', 'EncryptionAtRest$SseAwsKmsKeyId' => 'The ID of the KMS key to use for encryption at rest.
', 'ErrorByName$key' => NULL, 'ErrorDetail$ErrorCode' => 'The code associated with this error.
', 'EvaluatedMetricsMap$key' => NULL, 'FederatedDatabase$ConnectionName' => 'The name of the connection to the external metastore.
', 'FederatedTable$ConnectionName' => 'The name of the connection to the external metastore.
', 'FindMatchesTaskRunProperties$JobName' => 'The name assigned to the job for the Find Matches task run.
', 'GetBlueprintRequest$Name' => 'The name of the blueprint.
', 'GetBlueprintRunsRequest$BlueprintName' => 'The name of the blueprint.
', 'GetClassifierRequest$Name' => 'Name of the classifier to retrieve.
', 'GetColumnNamesList$member' => NULL, 'GetColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'GetColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'GetConnectionRequest$Name' => 'The name of the connection definition to retrieve.
', 'GetCrawlerRequest$Name' => 'The name of the crawler to retrieve metadata for.
', 'GetCustomEntityTypeRequest$Name' => 'The name of the custom pattern that you want to retrieve.
', 'GetCustomEntityTypeResponse$Name' => 'The name of the custom pattern that you retrieved.
', 'GetCustomEntityTypeResponse$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'GetDataQualityResultResponse$RulesetName' => 'The name of the ruleset associated with the data quality result.
', 'GetDataQualityResultResponse$JobName' => 'The job name associated with the data quality result, if any.
', 'GetDataQualityRuleRecommendationRunResponse$CreatedRulesetName' => 'The name of the ruleset that was created by the run.
', 'GetDataQualityRulesetRequest$Name' => 'The name of the ruleset.
', 'GetDataQualityRulesetResponse$Name' => 'The name of the ruleset.
', 'GetDatabaseRequest$Name' => 'The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
', 'GetJobRequest$JobName' => 'The name of the job definition to retrieve.
', 'GetJobRunRequest$JobName' => 'Name of the job definition being run.
', 'GetJobRunsRequest$JobName' => 'The name of the job definition for which to retrieve all job runs.
', 'GetMLTransformResponse$Name' => 'The unique name given to the transform when it was created.
', 'GetPartitionIndexesRequest$DatabaseName' => 'Specifies the name of a database from which you want to retrieve partition indexes.
', 'GetPartitionIndexesRequest$TableName' => 'Specifies the name of a table for which you want to retrieve the partition indexes.
', 'GetPartitionRequest$DatabaseName' => 'The name of the catalog database where the partition resides.
', 'GetPartitionRequest$TableName' => 'The name of the partition\'s table.
', 'GetPartitionsRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetPartitionsRequest$TableName' => 'The name of the partitions\' table.
', 'GetSecurityConfigurationRequest$Name' => 'The name of the security configuration to retrieve.
', 'GetSessionRequest$Id' => 'The ID of the session.
', 'GetStatementRequest$SessionId' => 'The Session ID of the statement.
', 'GetTableRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableRequest$Name' => 'The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionsRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionsRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'GetTablesRequest$DatabaseName' => 'The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
', 'GetTriggerRequest$Name' => 'The name of the trigger to retrieve.
', 'GetTriggersRequest$DependentJobName' => 'The name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are returned.
', 'GetUnfilteredPartitionMetadataRequest$DatabaseName' => '(Required) Specifies the name of a database that contains the partition.
', 'GetUnfilteredPartitionMetadataRequest$TableName' => '(Required) Specifies the name of a table that contains the partition.
', 'GetUnfilteredPartitionsMetadataRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetUnfilteredPartitionsMetadataRequest$TableName' => 'The name of the table that contains the partition.
', 'GetUnfilteredTableMetadataRequest$DatabaseName' => '(Required) Specifies the name of a database that contains the table.
', 'GetUnfilteredTableMetadataRequest$Name' => '(Required) Specifies the name of a table for which you are requesting metadata.
', 'GetUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function is located.
', 'GetUserDefinedFunctionRequest$FunctionName' => 'The name of the function.
', 'GetUserDefinedFunctionsRequest$DatabaseName' => 'The name of the catalog database where the functions are located. If none is provided, functions from all the databases across the catalog will be returned.
', 'GetUserDefinedFunctionsRequest$Pattern' => 'An optional function-name pattern string that filters the function definitions returned.
', 'GetWorkflowRequest$Name' => 'The name of the workflow to retrieve.
', 'GetWorkflowRunPropertiesRequest$Name' => 'Name of the workflow which was run.
', 'GetWorkflowRunRequest$Name' => 'Name of the workflow being run.
', 'GetWorkflowRunsRequest$Name' => 'Name of the workflow whose metadata of runs should be returned.
', 'GlueTable$DatabaseName' => 'A database name in the Glue Data Catalog.
', 'GlueTable$TableName' => 'A table name in the Glue Data Catalog.
', 'GlueTable$CatalogId' => 'A unique identifier for the Glue Data Catalog.
', 'GlueTable$ConnectionName' => 'The name of the connection to the Glue Data Catalog.
', 'GlueTableAdditionalOptions$key' => NULL, 'GrokClassifier$Name' => 'The name of the classifier.
', 'Job$Name' => 'The name you assign to this job definition.
', 'Job$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this job.
The name of the trigger that started this job run.
', 'JobRun$JobName' => 'The name of the job definition being used in this run.
', 'JobRun$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this job run.
The name of the SecurityConfiguration structure to be used with this job.
The name of the classifier.
', 'KeyList$member' => NULL, 'KeySchemaElement$Name' => 'The name of a partition key.
', 'ListCrawlsRequest$CrawlerName' => 'The name of the crawler whose runs you want to retrieve.
', 'ListStatementsRequest$SessionId' => 'The Session ID of the statements.
', 'ListTriggersRequest$DependentJobName' => 'The name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is no such trigger, all triggers are returned.
', 'MLTransform$Name' => 'A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
', 'MLUserDataEncryption$KmsKeyId' => 'The ID for the customer-provided KMS key.
', 'MatchCriteria$member' => NULL, 'NameStringList$member' => NULL, 'Node$Name' => 'The name of the Glue component represented by the node.
', 'Node$UniqueId' => 'The unique Id assigned to the node within the workflow.
', 'NodeIdList$member' => NULL, 'Order$Column' => 'The name of the column.
', 'Partition$DatabaseName' => 'The name of the catalog database in which to create the partition.
', 'Partition$TableName' => 'The name of the database table in which to create the partition.
', 'PartitionIndex$IndexName' => 'The name of the partition index.
', 'PartitionIndexDescriptor$IndexName' => 'The name of the partition index.
', 'PhysicalConnectionRequirements$SubnetId' => 'The subnet ID used by the connection.
', 'PhysicalConnectionRequirements$AvailabilityZone' => 'The connection\'s Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.
', 'Predecessor$JobName' => 'The name of the job definition used by the predecessor job run.
', 'PutWorkflowRunPropertiesRequest$Name' => 'Name of the workflow which was run.
', 'ResumeWorkflowRunRequest$Name' => 'The name of the workflow to resume.
', 'RulesetNames$member' => NULL, 'RunStatementRequest$SessionId' => 'The Session Id of the statement to be run.
', 'SecurityConfiguration$Name' => 'The name of the security configuration.
', 'SecurityGroupIdList$member' => NULL, 'SerDeInfo$Name' => 'Name of the SerDe.
', 'SerDeInfo$SerializationLibrary' => 'Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
The ID of the session.
', 'Session$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with the session.
', 'SessionCommand$Name' => 'Specifies the name of the SessionCommand. Can be \'glueetl\' or \'gluestreaming\'.
', 'SessionIdList$member' => NULL, 'StartCrawlerRequest$Name' => 'Name of the crawler to start.
', 'StartCrawlerScheduleRequest$CrawlerName' => 'Name of the crawler to schedule.
', 'StartDataQualityRuleRecommendationRunRequest$CreatedRulesetName' => 'A name for the ruleset.
', 'StartJobRunRequest$JobName' => 'The name of the job definition to use.
', 'StartJobRunRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with this job run.
The name of the trigger to start.
', 'StartTriggerResponse$Name' => 'The name of the trigger that was started.
', 'StartWorkflowRunRequest$Name' => 'The name of the workflow to start.
', 'StopCrawlerRequest$Name' => 'Name of the crawler to stop.
', 'StopCrawlerScheduleRequest$CrawlerName' => 'Name of the crawler whose schedule state to set.
', 'StopSessionRequest$Id' => 'The ID of the session to be stopped.
', 'StopSessionResponse$Id' => 'Returns the Id of the stopped session.
', 'StopTriggerRequest$Name' => 'The name of the trigger to stop.
', 'StopTriggerResponse$Name' => 'The name of the trigger that was stopped.
', 'StopWorkflowRunRequest$Name' => 'The name of the workflow to stop.
', 'Table$Name' => 'The table name. For Hive compatibility, this must be entirely lowercase.
', 'Table$DatabaseName' => 'The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
', 'Table$Owner' => 'The owner of the table.
', 'Table$CreatedBy' => 'The person or entity who created the table.
', 'TableError$TableName' => 'The name of the table. For Hive compatibility, this must be entirely lowercase.
', 'TableIdentifier$DatabaseName' => 'The name of the catalog database that contains the target table.
', 'TableIdentifier$Name' => 'The name of the target table.
', 'TableIdentifier$Region' => 'Region of the target table.
', 'TableInput$Name' => 'The table name. For Hive compatibility, this is folded to lowercase when it is stored.
', 'TableInput$Owner' => 'The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'TableVersionError$TableName' => 'The name of the table in question.
', 'TransformEncryption$TaskRunSecurityConfigurationName' => 'The name of the security configuration.
', 'TransformFilterCriteria$Name' => 'A unique transform name that is used to filter the machine learning transforms.
', 'Trigger$Name' => 'The name of the trigger.
', 'Trigger$WorkflowName' => 'The name of the workflow associated with the trigger.
', 'TriggerNameList$member' => NULL, 'TriggerUpdate$Name' => 'Reserved for future use.
', 'UpdateBlueprintResponse$Name' => 'Returns the name of the blueprint that was updated.
', 'UpdateColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'UpdateColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'UpdateColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'UpdateColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'UpdateConnectionRequest$Name' => 'The name of the connection definition to update.
', 'UpdateCrawlerRequest$Name' => 'Name of the new crawler.
', 'UpdateCrawlerScheduleRequest$CrawlerName' => 'The name of the crawler whose schedule to update.
', 'UpdateCsvClassifierRequest$Name' => 'The name of the classifier.
', 'UpdateDataQualityRulesetRequest$Name' => 'The name of the data quality ruleset.
', 'UpdateDataQualityRulesetResponse$Name' => 'The name of the data quality ruleset.
', 'UpdateDatabaseRequest$Name' => 'The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
', 'UpdateGrokClassifierRequest$Name' => 'The name of the GrokClassifier.
The name of the Glue job to be synchronized to or from the remote repository.
', 'UpdateJobFromSourceControlRequest$RepositoryName' => 'The name of the remote repository that contains the job artifacts.
', 'UpdateJobFromSourceControlRequest$RepositoryOwner' => 'The owner of the remote repository that contains the job artifacts.
', 'UpdateJobFromSourceControlRequest$BranchName' => 'An optional branch in the remote repository.
', 'UpdateJobFromSourceControlRequest$Folder' => 'An optional folder in the remote repository.
', 'UpdateJobFromSourceControlResponse$JobName' => 'The name of the Glue job.
', 'UpdateJobRequest$JobName' => 'The name of the job definition to update.
', 'UpdateJobResponse$JobName' => 'Returns the name of the updated job definition.
', 'UpdateJsonClassifierRequest$Name' => 'The name of the classifier.
', 'UpdateMLTransformRequest$Name' => 'The unique name that you gave the transform when you created it.
', 'UpdatePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'UpdatePartitionRequest$TableName' => 'The name of the table in which the partition to be updated is located.
', 'UpdateSourceControlFromJobRequest$JobName' => 'The name of the Glue job to be synchronized to or from the remote repository.
', 'UpdateSourceControlFromJobRequest$RepositoryName' => 'The name of the remote repository that contains the job artifacts.
', 'UpdateSourceControlFromJobRequest$RepositoryOwner' => 'The owner of the remote repository that contains the job artifacts.
', 'UpdateSourceControlFromJobRequest$BranchName' => 'An optional branch in the remote repository.
', 'UpdateSourceControlFromJobRequest$Folder' => 'An optional folder in the remote repository.
', 'UpdateSourceControlFromJobResponse$JobName' => 'The name of the Glue job.
', 'UpdateTableRequest$DatabaseName' => 'The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'UpdateTriggerRequest$Name' => 'The name of the trigger to update.
', 'UpdateUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function to be updated is located.
', 'UpdateUserDefinedFunctionRequest$FunctionName' => 'The name of the function.
', 'UpdateWorkflowRequest$Name' => 'Name of the workflow to be updated.
', 'UpdateWorkflowResponse$Name' => 'The name of the workflow which was specified in input.
', 'UpdateXMLClassifierRequest$Name' => 'The name of the classifier.
', 'UserDefinedFunction$FunctionName' => 'The name of the function.
', 'UserDefinedFunction$DatabaseName' => 'The name of the catalog database that contains the function.
', 'UserDefinedFunction$ClassName' => 'The Java class that contains the function code.
', 'UserDefinedFunction$OwnerName' => 'The owner of the function.
', 'UserDefinedFunctionInput$FunctionName' => 'The name of the function.
', 'UserDefinedFunctionInput$ClassName' => 'The Java class that contains the function code.
', 'UserDefinedFunctionInput$OwnerName' => 'The owner of the function.
', 'Workflow$Name' => 'The name of the workflow.
', 'WorkflowNames$member' => NULL, 'WorkflowRun$Name' => 'Name of the workflow that was run.
', 'XMLClassifier$Name' => 'The name of the classifier.
', ], ], 'NameStringList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionResponse$Succeeded' => 'A list of names of the connection definitions that were successfully deleted.
', 'GetUnfilteredPartitionMetadataResponse$AuthorizedColumns' => 'A list of column names that the user has been granted access to.
', 'GetUnfilteredTableMetadataResponse$AuthorizedColumns' => 'A list of column names that the user has been granted access to.
', 'SkewedInfo$SkewedColumnNames' => 'A list of names of columns that contain skewed values.
', 'StorageDescriptor$BucketColumns' => 'A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
', 'UnfilteredPartition$AuthorizedColumns' => 'The list of columns the user has permissions to access.
', ], ], 'NoScheduleException' => [ 'base' => 'There is no applicable schedule.
', 'refs' => [], ], 'Node' => [ 'base' => 'A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
', 'refs' => [ 'NodeList$member' => NULL, ], ], 'NodeId' => [ 'base' => NULL, 'refs' => [ 'CodeGenConfigurationNodes$key' => NULL, 'ManyInputs$member' => NULL, 'Merge$Source' => 'The source DynamicFrame that will be merged with a staging DynamicFrame.
A table, or a column in a table.
', 'TwoInputs$member' => NULL, ], ], 'NodeIdList' => [ 'base' => NULL, 'refs' => [ 'ResumeWorkflowRunRequest$NodeIds' => 'A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
', 'ResumeWorkflowRunResponse$NodeIds' => 'A list of the node IDs for the nodes that were actually restarted.
', ], ], 'NodeList' => [ 'base' => NULL, 'refs' => [ 'WorkflowGraph$Nodes' => 'A list of the the Glue components belong to the workflow represented as nodes.
', ], ], 'NodeName' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Name' => 'The name of the transform node.
', 'AmazonRedshiftSource$Name' => 'The name of the Amazon Redshift source.
', 'AmazonRedshiftTarget$Name' => 'The name of the Amazon Redshift target.
', 'ApplyMapping$Name' => 'The name of the transform node.
', 'AthenaConnectorSource$Name' => 'The name of the data source.
', 'BasicCatalogTarget$Name' => 'The name of your data target.
', 'CatalogDeltaSource$Name' => 'The name of the Delta Lake data source.
', 'CatalogHudiSource$Name' => 'The name of the Hudi data source.
', 'CatalogKafkaSource$Name' => 'The name of the data store.
', 'CatalogKinesisSource$Name' => 'The name of the data source.
', 'CatalogSource$Name' => 'The name of the data store.
', 'CustomCode$Name' => 'The name of the transform node.
', 'DQDLAliases$key' => NULL, 'DirectJDBCSource$Name' => 'The name of the JDBC source connection.
', 'DirectKafkaSource$Name' => 'The name of the data store.
', 'DirectKinesisSource$Name' => 'The name of the data source.
', 'DropDuplicates$Name' => 'The name of the transform node.
', 'DropFields$Name' => 'The name of the transform node.
', 'DropNullFields$Name' => 'The name of the transform node.
', 'DynamoDBCatalogSource$Name' => 'The name of the data source.
', 'EvaluateDataQuality$Name' => 'The name of the data quality evaluation.
', 'EvaluateDataQualityMultiFrame$Name' => 'The name of the data quality evaluation.
', 'FillMissingValues$Name' => 'The name of the transform node.
', 'Filter$Name' => 'The name of the transform node.
', 'GovernedCatalogSource$Name' => 'The name of the data store.
', 'GovernedCatalogTarget$Name' => 'The name of the data target.
', 'JDBCConnectorSource$Name' => 'The name of the data source.
', 'JDBCConnectorTarget$Name' => 'The name of the data target.
', 'Join$Name' => 'The name of the transform node.
', 'Merge$Name' => 'The name of the transform node.
', 'MicrosoftSQLServerCatalogSource$Name' => 'The name of the data source.
', 'MicrosoftSQLServerCatalogTarget$Name' => 'The name of the data target.
', 'MySQLCatalogSource$Name' => 'The name of the data source.
', 'MySQLCatalogTarget$Name' => 'The name of the data target.
', 'OracleSQLCatalogSource$Name' => 'The name of the data source.
', 'OracleSQLCatalogTarget$Name' => 'The name of the data target.
', 'PIIDetection$Name' => 'The name of the transform node.
', 'PostgreSQLCatalogSource$Name' => 'The name of the data source.
', 'PostgreSQLCatalogTarget$Name' => 'The name of the data target.
', 'Recipe$Name' => 'The name of the Glue Studio node.
', 'RedshiftSource$Name' => 'The name of the Amazon Redshift data store.
', 'RedshiftTarget$Name' => 'The name of the data target.
', 'RelationalCatalogSource$Name' => 'The name of the data source.
', 'RenameField$Name' => 'The name of the transform node.
', 'S3CatalogDeltaSource$Name' => 'The name of the Delta Lake data source.
', 'S3CatalogHudiSource$Name' => 'The name of the Hudi data source.
', 'S3CatalogSource$Name' => 'The name of the data store.
', 'S3CatalogTarget$Name' => 'The name of the data target.
', 'S3CsvSource$Name' => 'The name of the data store.
', 'S3DeltaCatalogTarget$Name' => 'The name of the data target.
', 'S3DeltaDirectTarget$Name' => 'The name of the data target.
', 'S3DeltaSource$Name' => 'The name of the Delta Lake source.
', 'S3DirectTarget$Name' => 'The name of the data target.
', 'S3GlueParquetTarget$Name' => 'The name of the data target.
', 'S3HudiCatalogTarget$Name' => 'The name of the data target.
', 'S3HudiDirectTarget$Name' => 'The name of the data target.
', 'S3HudiSource$Name' => 'The name of the Hudi source.
', 'S3JsonSource$Name' => 'The name of the data store.
', 'S3ParquetSource$Name' => 'The name of the data store.
', 'SelectFields$Name' => 'The name of the transform node.
', 'SelectFromCollection$Name' => 'The name of the transform node.
', 'SnowflakeSource$Name' => 'The name of the Snowflake data source.
', 'SnowflakeTarget$Name' => 'The name of the Snowflake target.
', 'SparkConnectorSource$Name' => 'The name of the data source.
', 'SparkConnectorTarget$Name' => 'The name of the data target.
', 'SparkSQL$Name' => 'The name of the transform node.
', 'Spigot$Name' => 'The name of the transform node.
', 'SplitFields$Name' => 'The name of the transform node.
', 'Union$Name' => 'The name of the transform node.
', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'Node$Type' => 'The type of Glue component represented by the node.
', ], ], 'NonNegativeDouble' => [ 'base' => NULL, 'refs' => [ 'BinaryColumnStatisticsData$AverageLength' => 'The average bit sequence length in the column.
', 'CrawlerHistory$DPUHour' => 'The number of data processing units (DPU) used in hours for the crawl.
', 'CrawlerMetrics$TimeLeftSeconds' => 'The estimated time left to complete a running crawl.
', 'CrawlerMetrics$LastRuntimeSeconds' => 'The duration of the crawler\'s most recent run, in seconds.
', 'CrawlerMetrics$MedianRuntimeSeconds' => 'The median duration of this crawler\'s runs, in seconds.
', 'StringColumnStatisticsData$AverageLength' => 'The average string length in the column.
', ], ], 'NonNegativeInt' => [ 'base' => NULL, 'refs' => [ 'SelectFromCollection$Index' => 'The index for the DynamicFrame to be selected.
', ], ], 'NonNegativeInteger' => [ 'base' => NULL, 'refs' => [ 'CrawlerMetrics$TablesCreated' => 'The number of tables created by this crawler.
', 'CrawlerMetrics$TablesUpdated' => 'The number of tables updated by this crawler.
', 'CrawlerMetrics$TablesDeleted' => 'The number of tables deleted by this crawler.
', 'Segment$SegmentNumber' => 'The zero-based index number of the segment. For example, if the total number of segments is 4, SegmentNumber values range from 0 through 3.
The retention time for this table.
', 'TableInput$Retention' => 'The retention time for this table.
', ], ], 'NonNegativeLong' => [ 'base' => NULL, 'refs' => [ 'BinaryColumnStatisticsData$MaximumLength' => 'The size of the longest bit sequence in the column.
', 'BinaryColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'BooleanColumnStatisticsData$NumberOfTrues' => 'The number of true values in the column.
', 'BooleanColumnStatisticsData$NumberOfFalses' => 'The number of false values in the column.
', 'BooleanColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DateColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DateColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'DecimalColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DecimalColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'DoubleColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DoubleColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'LongColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'LongColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'StringColumnStatisticsData$MaximumLength' => 'The size of the longest string in the column.
', 'StringColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'StringColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', ], ], 'NotificationProperty' => [ 'base' => 'Specifies configuration properties of a notification.
', 'refs' => [ 'Action$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', 'CreateJobRequest$NotificationProperty' => 'Specifies configuration properties of a job notification.
', 'Job$NotificationProperty' => 'Specifies configuration properties of a job notification.
', 'JobRun$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', 'JobUpdate$NotificationProperty' => 'Specifies the configuration properties of a job notification.
', 'StartJobRunRequest$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', ], ], 'NotifyDelayAfter' => [ 'base' => NULL, 'refs' => [ 'NotificationProperty$NotifyDelayAfter' => 'After a job run starts, the number of minutes to wait before sending a job run delay notification.
', ], ], 'NullCheckBoxList' => [ 'base' => 'Represents whether certain values are recognized as null values for removal.
', 'refs' => [ 'DropNullFields$NullCheckBoxList' => 'A structure that represents whether certain values are recognized as null values for removal.
', ], ], 'NullValueField' => [ 'base' => 'Represents a custom null value such as a zeros or other value being used as a null placeholder unique to the dataset.
', 'refs' => [ 'NullValueFields$member' => NULL, ], ], 'NullValueFields' => [ 'base' => NULL, 'refs' => [ 'DropNullFields$NullTextList' => 'A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The DropNullFields transform removes custom null values only if both the value of the null placeholder and the datatype match the data.
All columns request for audit.
', 'BatchGetBlueprintsRequest$IncludeBlueprint' => 'Specifies whether or not to include the blueprint in the response.
', 'BatchGetBlueprintsRequest$IncludeParameterSpec' => 'Specifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.
', 'BatchGetWorkflowsRequest$IncludeGraph' => 'Specifies whether to include a graph when returning the workflow resource metadata.
', 'CreateCsvClassifierRequest$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true.
', 'CreateCsvClassifierRequest$AllowSingleColumn' => 'Enables the processing of files that contain only one column.
', 'CreateCsvClassifierRequest$CustomDatatypeConfigured' => 'Enables the configuration of custom datatypes.
', 'CsvClassifier$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true.
Enables the processing of files that contain only one column.
', 'CsvClassifier$CustomDatatypeConfigured' => 'Enables the custom datatype to be configured.
', 'DataQualityEvaluationRunAdditionalRunOptions$CloudWatchMetricsEnabled' => 'Whether or not to enable CloudWatch metrics.
', 'DeltaTarget$WriteManifest' => 'Specifies whether to write the manifest files to the Delta table path.
', 'DeltaTarget$CreateNativeDeltaTable' => 'Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
', 'DynamoDBTarget$scanAll' => 'Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
Indicates whether or not the exception relates to a federated source.
', 'FindMatchesParameters$EnforceProvidedLabels' => 'The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
', 'GetBlueprintRequest$IncludeBlueprint' => 'Specifies whether or not to include the blueprint in the response.
', 'GetBlueprintRequest$IncludeParameterSpec' => 'Specifies whether or not to include the parameter specification.
', 'GetWorkflowRequest$IncludeGraph' => 'Specifies whether to include a graph when returning the workflow resource metadata.
', 'GetWorkflowRunRequest$IncludeGraph' => 'Specifies whether to include the workflow graph in response or not.
', 'GetWorkflowRunsRequest$IncludeGraph' => 'Specifies whether to include the workflow graph in response or not.
', 'InvalidInputException$FromFederationSource' => 'Indicates whether or not the exception relates to a federated source.
', 'LakeFormationConfiguration$UseLakeFormationCredentials' => 'Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
', 'MongoDBTarget$ScanAll' => 'Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
Specifies not to trim values before identifying the type of column values. The default value is true.
', 'UpdateCsvClassifierRequest$AllowSingleColumn' => 'Enables the processing of files that contain only one column.
', 'UpdateCsvClassifierRequest$CustomDatatypeConfigured' => 'Specifies the configuration of custom datatypes.
', ], ], 'NullableDouble' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$MaxCapacity' => 'For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
', 'DynamoDBTarget$scanRate' => 'The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
', 'EvaluatedMetricsMap$value' => NULL, 'GetMLTransformResponse$MaxCapacity' => 'The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
This field populates only for Auto Scaling job runs, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X, 2 for G.2X, or 0.25 for G.025X workers). This value may be different than the executionEngineRuntime * MaxCapacity as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity. Therefore, it is possible that the value of DPUSeconds is less than executionEngineRuntime * MaxCapacity.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
', 'StartJobRunRequest$MaxCapacity' => 'For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The number of workers of a defined workerType that are allocated to the development endpoint.
The number of workers of a defined workerType that are allocated when a job runs.
The number of workers of a defined workerType that are allocated when this task runs.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
The maximum number of times to retry a task for this transform after a task run fails.
', 'CreateSessionRequest$NumberOfWorkers' => 'The number of workers of a defined WorkerType to use for the session.
You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', 'DataQualityRulesetListDetails$RuleCount' => 'The number of rules in the ruleset.
', 'DevEndpoint$NumberOfWorkers' => 'The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The number of G.1X workers to be used in the run. The default is 5.
The number of G.1X workers to be used in the run. The default is 5.
The number of workers of a defined workerType that are allocated when this task runs.
The maximum number of times to retry a task for this transform after a task run fails.
', 'HudiTarget$MaximumTraversalDepth' => 'The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
', 'IcebergTarget$MaximumTraversalDepth' => 'The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
', 'Job$NumberOfWorkers' => 'The number of workers of a defined workerType that are allocated when a job runs.
The number of workers of a defined workerType that are allocated when a job runs.
The number of workers of a defined workerType that are allocated when a job runs.
The number of workers of a defined workerType that are allocated when a task of the transform runs.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
', 'StartDataQualityRuleRecommendationRunRequest$NumberOfWorkers' => 'The number of G.1X workers to be used in the run. The default is 5.
The number of G.1X workers to be used in the run. The default is 5.
The number of workers of a defined workerType that are allocated when a job runs.
Number of events in the batch.
', 'StartingEventBatchCondition$BatchWindow' => 'Duration of the batch window in seconds.
', 'UpdateMLTransformRequest$NumberOfWorkers' => 'The number of workers of a defined workerType that are allocated when this task runs.
The maximum number of times to retry a task for this transform after a task run fails.
', 'UpdateWorkflowRequest$MaxConcurrentRuns' => 'You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', 'Workflow$MaxConcurrentRuns' => 'You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', ], ], 'OneInput' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Inputs' => 'Specifies the fields and rows to use as inputs for the aggregate transform.
', 'AmazonRedshiftTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'ApplyMapping$Inputs' => 'The data inputs identified by their node names.
', 'BasicCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'DropDuplicates$Inputs' => 'The data inputs identified by their node names.
', 'DropFields$Inputs' => 'The data inputs identified by their node names.
', 'DropNullFields$Inputs' => 'The data inputs identified by their node names.
', 'DynamicTransform$Inputs' => 'Specifies the inputs for the dynamic transform that are required.
', 'EvaluateDataQuality$Inputs' => 'The inputs of your data quality evaluation.
', 'FillMissingValues$Inputs' => 'The data inputs identified by their node names.
', 'Filter$Inputs' => 'The data inputs identified by their node names.
', 'GovernedCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'JDBCConnectorTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'MicrosoftSQLServerCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'MySQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'OracleSQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'PIIDetection$Inputs' => 'The node ID inputs to the transform.
', 'PostgreSQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'Recipe$Inputs' => 'The nodes that are inputs to the recipe node, identified by id.
', 'RedshiftTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'RenameField$Inputs' => 'The data inputs identified by their node names.
', 'S3CatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DeltaCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DeltaDirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3GlueParquetTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3HudiCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3HudiDirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'SelectFields$Inputs' => 'The data inputs identified by their node names.
', 'SelectFromCollection$Inputs' => 'The data inputs identified by their node names.
', 'SnowflakeTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'SparkConnectorTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'Spigot$Inputs' => 'The data inputs identified by their node names.
', 'SplitFields$Inputs' => 'The data inputs identified by their node names.
', ], ], 'OpenTableFormatInput' => [ 'base' => 'A structure representing an open format table.
', 'refs' => [ 'CreateTableRequest$OpenTableFormatInput' => 'Specifies an OpenTableFormatInput structure when creating an open format table.
The operation timed out.
', 'refs' => [], ], 'Option' => [ 'base' => 'Specifies an option value.
', 'refs' => [ 'AmazonRedshiftNodeData$Connection' => 'The Glue connection to the Redshift cluster.
', 'AmazonRedshiftNodeData$Schema' => 'The Redshift schema name when working with a direct connection.
', 'AmazonRedshiftNodeData$Table' => 'The Redshift table name when working with a direct connection.
', 'AmazonRedshiftNodeData$CatalogDatabase' => 'The name of the Glue Data Catalog database when working with a data catalog.
', 'AmazonRedshiftNodeData$CatalogTable' => 'The Glue Data Catalog table name when working with a data catalog.
', 'AmazonRedshiftNodeData$IamRole' => 'Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
', 'OptionList$member' => NULL, 'SnowflakeNodeData$Connection' => 'Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
', 'SnowflakeNodeData$IamRole' => 'Not currently used.
', ], ], 'OptionList' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$TableSchema' => 'The array of schema output for a given node.
', 'AmazonRedshiftNodeData$SelectedColumns' => 'The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
', 'SnowflakeNodeData$SelectedColumns' => 'Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value, label and description keys. Each structure describes a column.
Manually defines the target schema for the node. A list of structures with value , label and description keys. Each structure defines a column.
Specifies an Oracle data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$OracleSQLCatalogSource' => 'Specifies an Oracle data source in the Glue Data Catalog.
', ], ], 'OracleSQLCatalogTarget' => [ 'base' => 'Specifies a target that uses Oracle SQL.
', 'refs' => [ 'CodeGenConfigurationNode$OracleSQLCatalogTarget' => 'Specifies a target that uses Oracle SQL.
', ], ], 'OrchestrationArgumentsMap' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$DefaultArguments' => 'A map array of key-value pairs. Max is 75 pairs.
', 'Session$DefaultArguments' => 'A map array of key-value pairs. Max is 75 pairs.
', ], ], 'OrchestrationArgumentsValue' => [ 'base' => NULL, 'refs' => [ 'OrchestrationArgumentsMap$value' => NULL, ], ], 'OrchestrationIAMRoleArn' => [ 'base' => NULL, 'refs' => [ 'BlueprintRun$RoleArn' => 'The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
', 'StartBlueprintRunRequest$RoleArn' => 'Specifies the IAM role used to create the workflow.
', ], ], 'OrchestrationNameString' => [ 'base' => NULL, 'refs' => [ 'BatchGetBlueprintNames$member' => NULL, 'Blueprint$Name' => 'The name of the blueprint.
', 'BlueprintDetails$BlueprintName' => 'The name of the blueprint.
', 'BlueprintNames$member' => NULL, 'BlueprintRun$BlueprintName' => 'The name of the blueprint.
', 'CancelStatementRequest$RequestOrigin' => 'The origin of the request to cancel the statement.
', 'CreateBlueprintRequest$Name' => 'The name of the blueprint.
', 'CreateSessionRequest$RequestOrigin' => 'The origin of the request.
', 'DeleteSessionRequest$RequestOrigin' => 'The name of the origin of the delete session request.
', 'GetBlueprintRunRequest$BlueprintName' => 'The name of the blueprint.
', 'GetSessionRequest$RequestOrigin' => 'The origin of the request.
', 'GetStatementRequest$RequestOrigin' => 'The origin of the request.
', 'ListSessionsRequest$RequestOrigin' => 'The origin of the request.
', 'ListStatementsRequest$RequestOrigin' => 'The origin of the request to list statements.
', 'OrchestrationArgumentsMap$key' => NULL, 'RunStatementRequest$RequestOrigin' => 'The origin of the request.
', 'StartBlueprintRunRequest$BlueprintName' => 'The name of the blueprint.
', 'StopSessionRequest$RequestOrigin' => 'The origin of the request.
', 'UpdateBlueprintRequest$Name' => 'The name of the blueprint.
', ], ], 'OrchestrationRoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$Role' => 'The IAM Role ARN
', 'Session$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
', ], ], 'OrchestrationS3Location' => [ 'base' => NULL, 'refs' => [ 'CreateBlueprintRequest$BlueprintLocation' => 'Specifies a path in Amazon S3 where the blueprint is published.
', 'UpdateBlueprintRequest$BlueprintLocation' => 'Specifies a path in Amazon S3 where the blueprint is published.
', ], ], 'OrchestrationStatementCodeString' => [ 'base' => NULL, 'refs' => [ 'RunStatementRequest$Code' => 'The statement code to be run.
', ], ], 'OrchestrationStringList' => [ 'base' => NULL, 'refs' => [ 'ConnectionsList$Connections' => 'A list of connections used by the job.
', 'StatementOutput$Traceback' => 'The traceback of the output.
', ], ], 'OrchestrationToken' => [ 'base' => NULL, 'refs' => [ 'ListSessionsRequest$NextToken' => 'The token for the next set of results, or null if there are no more result.
', 'ListSessionsResponse$NextToken' => 'The token for the next set of results, or null if there are no more result.
', 'ListStatementsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListStatementsResponse$NextToken' => 'A continuation token, if not all statements have yet been returned.
', ], ], 'Order' => [ 'base' => 'Specifies the sort order of a sorted column.
', 'refs' => [ 'OrderList$member' => NULL, ], ], 'OrderList' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$SortColumns' => 'A list specifying the sort order of each bucket in the table.
', ], ], 'OtherMetadataValueList' => [ 'base' => NULL, 'refs' => [ 'MetadataInfo$OtherMetadataValueList' => 'Other metadata belonging to the same metadata key.
', ], ], 'OtherMetadataValueListItem' => [ 'base' => 'A structure containing other metadata for a schema version belonging to the same metadata key.
', 'refs' => [ 'OtherMetadataValueList$member' => NULL, ], ], 'PIIDetection' => [ 'base' => 'Specifies a transform that identifies, removes or masks PII data.
', 'refs' => [ 'CodeGenConfigurationNode$PIIDetection' => 'Specifies a transform that identifies, removes or masks PII data.
', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'GetBlueprintRunsRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetClassifiersRequest$MaxResults' => 'The size of the list to return (optional).
', 'GetConnectionsRequest$MaxResults' => 'The maximum number of connections to return in one response.
', 'GetCrawlerMetricsRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetCrawlersRequest$MaxResults' => 'The number of crawlers to return on each call.
', 'GetDevEndpointsRequest$MaxResults' => 'The maximum size of information to return.
', 'GetJobRunsRequest$MaxResults' => 'The maximum size of the response.
', 'GetJobsRequest$MaxResults' => 'The maximum size of the response.
', 'GetMLTaskRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetMLTransformsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetPartitionsRequest$MaxResults' => 'The maximum number of partitions to return in a single response.
', 'GetResourcePoliciesRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetSecurityConfigurationsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetTriggersRequest$MaxResults' => 'The maximum size of the response.
', 'GetUnfilteredPartitionsMetadataRequest$MaxResults' => 'The maximum number of partitions to return in a single response.
', 'GetWorkflowRunsRequest$MaxResults' => 'The maximum number of workflow runs to be included in the response.
', 'ListBlueprintsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListCrawlersRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListCrawlsRequest$MaxResults' => 'The maximum number of results to return. The default is 20, and maximum is 100.
', 'ListCustomEntityTypesRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityResultsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRuleRecommendationRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRulesetEvaluationRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRulesetsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDevEndpointsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListJobsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListMLTransformsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListSessionsRequest$MaxResults' => 'The maximum number of results.
', 'ListTriggersRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListWorkflowsRequest$MaxResults' => 'The maximum size of a list to return.
', 'SearchTablesRequest$MaxResults' => 'The maximum number of tables to return in a single response.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'GetMLTaskRunsRequest$NextToken' => 'A token for pagination of the results. The default is empty.
', 'GetMLTaskRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'GetMLTransformsRequest$NextToken' => 'A paginated token to offset the results.
', 'GetMLTransformsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListCustomEntityTypesRequest$NextToken' => 'A paginated token to offset the results.
', 'ListCustomEntityTypesResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityResultsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityResultsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRuleRecommendationRunsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRuleRecommendationRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRulesetEvaluationRunsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRulesetEvaluationRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRulesetsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRulesetsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListMLTransformsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListMLTransformsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', ], ], 'ParamType' => [ 'base' => NULL, 'refs' => [ 'TransformConfigParameter$Type' => 'Specifies the parameter type in the config file of the dynamic transform.
', 'TransformConfigParameter$ListType' => 'Specifies the list type of the parameter in the config file of the dynamic transform.
', ], ], 'ParametersMap' => [ 'base' => NULL, 'refs' => [ 'Column$Parameters' => 'These key-value pairs define properties associated with the column.
', 'Database$Parameters' => 'These key-value pairs define parameters and properties of the database.
', 'DatabaseInput$Parameters' => 'These key-value pairs define parameters and properties of the database.
These key-value pairs define parameters and properties of the database.
', 'Partition$Parameters' => 'These key-value pairs define partition parameters.
', 'PartitionInput$Parameters' => 'These key-value pairs define partition parameters.
', 'SerDeInfo$Parameters' => 'These key-value pairs define initialization parameters for the SerDe.
', 'StorageDescriptor$Parameters' => 'The user-supplied properties in key-value form.
', 'Table$Parameters' => 'These key-value pairs define properties associated with the table.
', 'TableInput$Parameters' => 'These key-value pairs define properties associated with the table.
', ], ], 'ParametersMapValue' => [ 'base' => NULL, 'refs' => [ 'ParametersMap$value' => NULL, ], ], 'ParquetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3GlueParquetTarget$Compression' => '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 how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip").
Represents a slice of table data.
', 'refs' => [ 'GetPartitionResponse$Partition' => 'The requested information, in the form of a Partition object.
A Partition object containing the partition metadata.
', 'PartitionList$member' => NULL, 'UnfilteredPartition$Partition' => 'The partition object.
', ], ], 'PartitionError' => [ 'base' => 'Contains information about a partition error.
', 'refs' => [ 'PartitionErrors$member' => NULL, ], ], 'PartitionErrors' => [ 'base' => NULL, 'refs' => [ 'BatchCreatePartitionResponse$Errors' => 'The errors encountered when trying to create the requested partitions.
', 'BatchDeletePartitionResponse$Errors' => 'The errors encountered when trying to delete the requested partitions.
', ], ], 'PartitionIndex' => [ 'base' => 'A structure for a partition index.
', 'refs' => [ 'CreatePartitionIndexRequest$PartitionIndex' => 'Specifies a PartitionIndex structure to create a partition index in an existing table.
A descriptor for a partition index in a table.
', 'refs' => [ 'PartitionIndexDescriptorList$member' => NULL, ], ], 'PartitionIndexDescriptorList' => [ 'base' => NULL, 'refs' => [ 'GetPartitionIndexesResponse$PartitionIndexDescriptorList' => 'A list of index descriptors.
', ], ], 'PartitionIndexList' => [ 'base' => NULL, 'refs' => [ 'CreateTableRequest$PartitionIndexes' => 'A list of partition indexes, PartitionIndex structures, to create in the table.
The status of the partition index.
The possible statuses are:
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
ACTIVE: The index creation succeeds.
FAILED: The index creation fails.
DELETING: The index is deleted from the list of indexes.
The structure used to create and update a partition.
', 'refs' => [ 'BatchUpdatePartitionRequestEntry$PartitionInput' => 'The structure used to update a partition.
', 'CreatePartitionRequest$PartitionInput' => 'A PartitionInput structure defining the partition to be created.
The new partition object to update the partition to.
The Values property can\'t be changed. If you want to change the partition key values for a partition, delete and recreate the partition.
A list of PartitionInput structures that define the partitions to be created.
A list of the requested partitions.
', 'GetPartitionsResponse$Partitions' => 'A list of requested partitions.
', ], ], 'PartitionValueList' => [ 'base' => 'Contains a list of values defining partitions.
', 'refs' => [ 'BackfillErroredPartitionsList$member' => NULL, 'BatchDeletePartitionValueList$member' => NULL, 'BatchGetPartitionValueList$member' => NULL, ], ], 'Path' => [ 'base' => NULL, 'refs' => [ 'DynamoDBTarget$Path' => 'The name of the DynamoDB table to crawl.
', 'JdbcTarget$Path' => 'The path of the JDBC target.
', 'MongoDBTarget$Path' => 'The path of the Amazon DocumentDB or MongoDB target (database/collection).
', 'PathList$member' => NULL, 'S3Target$Path' => 'The path to the Amazon S3 target.
', ], ], 'PathList' => [ 'base' => NULL, 'refs' => [ 'DeltaTarget$DeltaTables' => 'A list of the Amazon S3 paths to the Delta tables.
', 'HudiTarget$Paths' => 'An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
', 'HudiTarget$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'IcebergTarget$Paths' => 'One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'JdbcTarget$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'S3Target$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', ], ], 'Permission' => [ 'base' => NULL, 'refs' => [ 'PermissionList$member' => NULL, ], ], 'PermissionList' => [ 'base' => NULL, 'refs' => [ 'PrincipalPermissions$Permissions' => 'The permissions that are granted to the principal.
', ], ], 'PermissionType' => [ 'base' => NULL, 'refs' => [ 'PermissionTypeList$member' => NULL, ], ], 'PermissionTypeList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$SupportedPermissionTypes' => '(Required) A list of supported permission types.
', 'GetUnfilteredPartitionsMetadataRequest$SupportedPermissionTypes' => 'A list of supported permission types.
', 'GetUnfilteredTableMetadataRequest$SupportedPermissionTypes' => '(Required) A list of supported permission types.
', ], ], 'PermissionTypeMismatchException' => [ 'base' => 'The operation timed out.
', 'refs' => [], ], 'PhysicalConnectionRequirements' => [ 'base' => 'Specifies the physical requirements for a connection.
', 'refs' => [ 'Connection$PhysicalConnectionRequirements' => 'A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.
Indicates the type of PIIDetection transform.
', ], ], 'PolicyJsonString' => [ 'base' => NULL, 'refs' => [ 'GetResourcePolicyResponse$PolicyInJson' => 'Contains the requested policy document, in JSON format.
', 'GluePolicy$PolicyInJson' => 'Contains the requested policy document, in JSON format.
', 'PutResourcePolicyRequest$PolicyInJson' => 'Contains the policy document to set, in JSON format.
', ], ], 'PollingTime' => [ 'base' => NULL, 'refs' => [ 'StreamingDataPreviewOptions$PollingTime' => 'The polling time in milliseconds.
', ], ], 'PositiveLong' => [ 'base' => NULL, 'refs' => [ 'StreamingDataPreviewOptions$RecordPollingLimit' => 'The limit to the number of records polled.
', ], ], 'PostgreSQLCatalogSource' => [ 'base' => 'Specifies a PostgresSQL data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$PostgreSQLCatalogSource' => 'Specifies a PostgresSQL data source in the Glue Data Catalog.
', ], ], 'PostgreSQLCatalogTarget' => [ 'base' => 'Specifies a target that uses Postgres SQL.
', 'refs' => [ 'CodeGenConfigurationNode$PostgreSQLCatalogTarget' => 'Specifies a target that uses Postgres SQL.
', ], ], 'Predecessor' => [ 'base' => 'A job run that was used in the predicate of a conditional trigger that triggered this job run.
', 'refs' => [ 'PredecessorList$member' => NULL, ], ], 'PredecessorList' => [ 'base' => NULL, 'refs' => [ 'JobRun$PredecessorRuns' => 'A list of predecessors to this job run.
', ], ], 'Predicate' => [ 'base' => 'Defines the predicate of the trigger, which determines when it fires.
', 'refs' => [ 'CreateTriggerRequest$Predicate' => 'A predicate to specify when the new trigger should fire.
This field is required when the trigger type is CONDITIONAL.
The predicate of this trigger, which defines when it will fire.
', 'TriggerUpdate$Predicate' => 'The predicate of this trigger, which defines when it will fire.
', ], ], 'PredicateString' => [ 'base' => NULL, 'refs' => [ 'ColumnRowFilter$RowFilterExpression' => 'A string containing the row-level filter expression.
', 'GetPartitionsRequest$Expression' => 'An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume \'variable a\' holds 10 and \'variable b\' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING, to be compatible with the catalog partitions.
Sample API Call:
', 'GetUnfilteredPartitionsMetadataRequest$Expression' => 'An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume \'variable a\' holds 10 and \'variable b\' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
', ], ], 'PrincipalPermissions' => [ 'base' => 'Permissions granted to a principal.
', 'refs' => [ 'PrincipalPermissionsList$member' => NULL, ], ], 'PrincipalPermissionsList' => [ 'base' => NULL, 'refs' => [ 'Database$CreateTableDefaultPermissions' => 'Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
', 'DatabaseInput$CreateTableDefaultPermissions' => 'Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'UserDefinedFunction$OwnerType' => 'The owner type.
', 'UserDefinedFunctionInput$OwnerType' => 'The owner type.
', ], ], 'Prob' => [ 'base' => NULL, 'refs' => [ 'Spigot$Prob' => 'The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
', ], ], 'PropertyPredicate' => [ 'base' => 'Defines a property predicate.
', 'refs' => [ 'SearchPropertyPredicates$member' => NULL, ], ], 'PublicKeysList' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$PublicKeys' => 'A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
A list of public keys to be used by the DevEndpoints for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
The list of public keys for the DevEndpoint to use.
The list of public keys to be deleted from the DevEndpoint.
The Python script generated from the DAG.
', 'GetDataflowGraphRequest$PythonScript' => 'The Python script to transform.
', 'GetPlanResponse$PythonScript' => 'A Python script to perform the mapping.
', ], ], 'PythonVersionString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$PythonVersion' => 'The Python version being used to run a Python shell job. Allowed values are 2 or 3.
', 'SessionCommand$PythonVersion' => 'Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
', ], ], 'QuerySchemaVersionMetadataInput' => [ 'base' => NULL, 'refs' => [], ], 'QuerySchemaVersionMetadataMaxResults' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', ], ], 'QuerySchemaVersionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'QuoteChar' => [ 'base' => NULL, 'refs' => [ 'S3CsvSource$QuoteChar' => 'Specifies the character to use for quoting. The default is a double quote: \'"\'. Set this to -1 to turn off quoting entirely.
A Glue Studio node that uses a Glue DataBrew recipe in Glue jobs.
', 'refs' => [ 'CodeGenConfigurationNode$Recipe' => 'Specifies a Glue DataBrew recipe node.
', ], ], 'RecipeReference' => [ 'base' => 'A reference to a Glue DataBrew recipe.
', 'refs' => [ 'Recipe$RecipeReference' => 'A reference to the DataBrew recipe used by the node.
', ], ], 'RecipeVersion' => [ 'base' => NULL, 'refs' => [ 'RecipeReference$RecipeVersion' => 'The RecipeVersion of the DataBrew recipe.
', ], ], 'RecordsCount' => [ 'base' => NULL, 'refs' => [ 'ConfusionMatrix$NumTruePositives' => 'The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumFalsePositives' => 'The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumTrueNegatives' => 'The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumFalseNegatives' => 'The number of matches in the data that the transform didn\'t find, in the confusion matrix for your transform.
', ], ], 'RecrawlBehavior' => [ 'base' => NULL, 'refs' => [ 'RecrawlPolicy$RecrawlBehavior' => 'Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in Glue in the developer guide.
', 'refs' => [ 'Crawler$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', 'CreateCrawlerRequest$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', 'UpdateCrawlerRequest$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', ], ], 'RedshiftSource' => [ 'base' => 'Specifies an Amazon Redshift data store.
', 'refs' => [ 'CodeGenConfigurationNode$RedshiftSource' => 'Specifies an Amazon Redshift data store.
', ], ], 'RedshiftTarget' => [ 'base' => 'Specifies a target that uses Amazon Redshift.
', 'refs' => [ 'CodeGenConfigurationNode$RedshiftTarget' => 'Specifies a target that uses Amazon Redshift.
', ], ], 'RegisterSchemaVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'RegisterSchemaVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegistryId' => [ 'base' => 'A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'refs' => [ 'CreateSchemaInput$RegistryId' => ' This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.
This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'GetRegistryInput$RegistryId' => 'This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'ListSchemasInput$RegistryId' => 'A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'UpdateRegistryInput$RegistryId' => 'This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', ], ], 'RegistryListDefinition' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesResponse$Registries' => 'An array of RegistryDetailedListItem objects containing minimal details of each registry.
A structure containing the details for a registry.
', 'refs' => [ 'RegistryListDefinition$member' => NULL, ], ], 'RegistryStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistryResponse$Status' => 'The status of the registry. A successful operation will return the Deleting status.
The status of the registry.
', 'RegistryListItem$Status' => 'The status of the registry.
', ], ], 'RelationalCatalogSource' => [ 'base' => 'Specifies a Relational database data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$RelationalCatalogSource' => 'Specifies a relational catalog data store in the Glue Data Catalog.
', ], ], 'RemoveSchemaVersionMetadataInput' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSchemaVersionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenameField' => [ 'base' => 'Specifies a transform that renames a single data property key.
', 'refs' => [ 'CodeGenConfigurationNode$RenameField' => 'Specifies a transform that renames a single data property key.
', ], ], 'ReplaceBoolean' => [ 'base' => NULL, 'refs' => [ 'ImportLabelsTaskRunProperties$Replace' => 'Indicates whether to overwrite your existing labels.
', 'StartImportLabelsTaskRunRequest$ReplaceAllLabels' => 'Indicates whether to overwrite your existing labels.
', ], ], 'ResetJobBookmarkRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetJobBookmarkResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotReadyException' => [ 'base' => 'A resource was not ready for a transaction.
', 'refs' => [], ], 'ResourceNumberLimitExceededException' => [ 'base' => 'A resource numerical limit was exceeded.
', 'refs' => [], ], 'ResourceShareType' => [ 'base' => NULL, 'refs' => [ 'GetDatabasesRequest$ResourceShareType' => 'Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.
If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.
If set to FOREIGN, will list the databases shared with your account.
If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.
Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.
If set to FOREIGN, will search the tables shared with your account.
If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.
The type of the resource.
', ], ], 'ResourceUri' => [ 'base' => 'The URIs for function resources.
', 'refs' => [ 'ResourceUriList$member' => NULL, ], ], 'ResourceUriList' => [ 'base' => NULL, 'refs' => [ 'UserDefinedFunction$ResourceUris' => 'The resource URIs for the function.
', 'UserDefinedFunctionInput$ResourceUris' => 'The resource URIs for the function.
', ], ], 'ResumeWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResumeWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'Crawler$Role' => 'The Amazon Resource Name (ARN) of an IAM role that\'s used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
', 'CreateCrawlerRequest$Role' => 'The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
', 'UpdateCrawlerRequest$Role' => 'The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$RoleArn' => 'The IAM role for the DevEndpoint.
The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint.
The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint.
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
', 'CreateMLTransformRequest$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
An IAM role supplied to encrypt the results of the run.
', 'GetDataQualityRulesetEvaluationRunResponse$Role' => 'An IAM role supplied to encrypt the results of the run.
', 'GetMLTransformResponse$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
', 'Job$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
', 'JobUpdate$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
', 'MLTransform$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
An IAM role supplied to encrypt the results of the run.
', 'StartDataQualityRulesetEvaluationRunRequest$Role' => 'An IAM role supplied to encrypt the results of the run.
', 'UpdateMLTransformRequest$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
', ], ], 'RowTag' => [ 'base' => NULL, 'refs' => [ 'CreateXMLClassifierRequest$RowTag' => 'The XML tag designating the element that contains each record in an XML document being parsed. This can\'t identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
The XML tag designating the element that contains each record in an XML document being parsed. This cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
The XML tag designating the element that contains each record in an XML document being parsed. This can\'t identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
A list of ruleset names for the run.
', 'StartDataQualityRulesetEvaluationRunRequest$RulesetNames' => 'A list of ruleset names.
', ], ], 'RunId' => [ 'base' => NULL, 'refs' => [ 'GetJobBookmarkRequest$RunId' => 'The unique run identifier associated with this job run.
', 'JobBookmarkEntry$PreviousRunId' => 'The unique run identifier associated with the previous job run.
', 'JobBookmarkEntry$RunId' => 'The run ID number.
', 'ResetJobBookmarkRequest$RunId' => 'The unique run identifier associated with this job run.
', ], ], 'RunStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'RuntimeNameString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$Runtime' => 'In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Working with Ray jobs in the Glue Developer Guide.
', ], ], 'S3CatalogDeltaSource' => [ 'base' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogDeltaSource' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', ], ], 'S3CatalogHudiSource' => [ 'base' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog. The Hudi data source must be stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogHudiSource' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', ], ], 'S3CatalogSource' => [ 'base' => 'Specifies an Amazon S3 data store in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogSource' => 'Specifies an Amazon S3 data store in the Glue Data Catalog.
', ], ], 'S3CatalogTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogTarget' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', ], ], 'S3CsvSource' => [ 'base' => 'Specifies a command-separated value (CSV) data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CsvSource' => 'Specifies a command-separated value (CSV) data store stored in Amazon S3.
', ], ], 'S3DeltaCatalogTarget' => [ 'base' => 'Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaCatalogTarget' => 'Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
', ], ], 'S3DeltaDirectTarget' => [ 'base' => 'Specifies a target that writes to a Delta Lake data source in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaDirectTarget' => 'Specifies a target that writes to a Delta Lake data source in Amazon S3.
', ], ], 'S3DeltaSource' => [ 'base' => 'Specifies a Delta Lake data source stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaSource' => 'Specifies a Delta Lake data source stored in Amazon S3.
', ], ], 'S3DirectSourceAdditionalOptions' => [ 'base' => 'Specifies additional connection options for the Amazon S3 data store.
', 'refs' => [ 'S3CsvSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3DeltaSource$AdditionalOptions' => 'Specifies additional options for the connector.
', 'S3HudiSource$AdditionalOptions' => 'Specifies additional options for the connector.
', 'S3JsonSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3ParquetSource$AdditionalOptions' => 'Specifies additional connection options.
', ], ], 'S3DirectTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DirectTarget' => 'Specifies a data target that writes to Amazon S3.
', ], ], 'S3Encryption' => [ 'base' => 'Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
', 'refs' => [ 'S3EncryptionList$member' => NULL, ], ], 'S3EncryptionList' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$S3Encryption' => 'The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
', ], ], 'S3EncryptionMode' => [ 'base' => NULL, 'refs' => [ 'S3Encryption$S3EncryptionMode' => 'The encryption mode to use for Amazon S3 data.
', ], ], 'S3GlueParquetTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', 'refs' => [ 'CodeGenConfigurationNode$S3GlueParquetTarget' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', ], ], 'S3HudiCatalogTarget' => [ 'base' => 'Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiCatalogTarget' => 'Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
', ], ], 'S3HudiDirectTarget' => [ 'base' => 'Specifies a target that writes to a Hudi data source in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiDirectTarget' => 'Specifies a target that writes to a Hudi data source in Amazon S3.
', ], ], 'S3HudiSource' => [ 'base' => 'Specifies a Hudi data source stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiSource' => 'Specifies a Hudi data source stored in Amazon S3.
', ], ], 'S3JsonSource' => [ 'base' => 'Specifies a JSON data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3JsonSource' => 'Specifies a JSON data store stored in Amazon S3.
', ], ], 'S3ParquetSource' => [ 'base' => 'Specifies an Apache Parquet data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3ParquetSource' => 'Specifies an Apache Parquet data store stored in Amazon S3.
', ], ], 'S3SourceAdditionalOptions' => [ 'base' => 'Specifies additional connection options for the Amazon S3 data store.
', 'refs' => [ 'GovernedCatalogSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3CatalogSource$AdditionalOptions' => 'Specifies additional connection options.
', ], ], 'S3Target' => [ 'base' => 'Specifies a data store in Amazon Simple Storage Service (Amazon S3).
', 'refs' => [ 'S3TargetList$member' => NULL, ], ], 'S3TargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$S3Targets' => 'Specifies Amazon Simple Storage Service (Amazon S3) targets.
', ], ], 'ScalaCode' => [ 'base' => NULL, 'refs' => [ 'CreateScriptResponse$ScalaCode' => 'The Scala code generated from the DAG.
', 'GetPlanResponse$ScalaCode' => 'The Scala code to perform the mapping.
', ], ], 'Schedule' => [ 'base' => 'A scheduling object using a cron statement to schedule an event.
For scheduled crawlers, the schedule when the crawler runs.
', ], ], 'ScheduleState' => [ 'base' => NULL, 'refs' => [ 'Schedule$State' => 'The state of the schedule.
', ], ], 'SchedulerNotRunningException' => [ 'base' => 'The specified scheduler is not running.
', 'refs' => [], ], 'SchedulerRunningException' => [ 'base' => 'The specified scheduler is already running.
', 'refs' => [], ], 'SchedulerTransitioningException' => [ 'base' => 'The specified scheduler is transitioning.
', 'refs' => [], ], 'SchemaChangePolicy' => [ 'base' => 'A policy that specifies update and deletion behaviors for the crawler.
', 'refs' => [ 'Crawler$SchemaChangePolicy' => 'The policy that specifies update and delete behaviors for the crawler.
', 'CreateCrawlerRequest$SchemaChangePolicy' => 'The policy for the crawler\'s update and deletion behavior.
', 'UpdateCrawlerRequest$SchemaChangePolicy' => 'The policy for the crawler\'s update and deletion behavior.
', ], ], 'SchemaCheckpointNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$SchemaCheckpoint' => 'The version number of the checkpoint (the last time the compatibility mode was changed).
', 'GetSchemaResponse$SchemaCheckpoint' => 'The version number of the checkpoint (the last time the compatibility mode was changed).
', ], ], 'SchemaColumn' => [ 'base' => 'A key-value pair representing a column and data type that this transform can run against. The Schema parameter of the MLTransform may contain up to 100 of these structures.
The difference between schemas as a string in JsonPatch format.
', ], ], 'SchemaDefinitionString' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityInput$SchemaDefinition' => 'The definition of the schema that has to be validated.
', 'CreateSchemaInput$SchemaDefinition' => 'The schema definition using the DataFormat setting for SchemaName.
The definition of the schema for which schema details are required.
', 'GetSchemaVersionResponse$SchemaDefinition' => 'The schema definition for the schema ID.
', 'RegisterSchemaVersionInput$SchemaDefinition' => 'The schema definition using the DataFormat setting for the SchemaName.
Refers to SYNTAX_DIFF, which is the currently supported diff type.
The unique ID of the schema in the Glue schema registry.
', 'refs' => [ 'DeleteSchemaInput$SchemaId' => 'This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'DeleteSchemaVersionsInput$SchemaId' => 'This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'GetSchemaByDefinitionInput$SchemaId' => 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
The unique ID for the schema.
', 'QuerySchemaVersionMetadataInput$SchemaId' => 'A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'RegisterSchemaVersionInput$SchemaId' => 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'SchemaReference$SchemaId' => 'A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.
An array of SchemaListItem objects containing details of each schema.
An object that contains minimal details for a schema.
', 'refs' => [ 'SchemaListDefinition$member' => NULL, ], ], 'SchemaPathString' => [ 'base' => NULL, 'refs' => [ 'MappingEntry$SourcePath' => 'The source path.
', 'MappingEntry$TargetPath' => 'The target path.
', ], ], 'SchemaReference' => [ 'base' => 'An object that references a schema stored in the Glue Schema Registry.
', 'refs' => [ 'StorageDescriptor$SchemaReference' => 'An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
', ], ], 'SchemaRegistryNameString' => [ 'base' => NULL, 'refs' => [ 'CreateRegistryInput$RegistryName' => 'Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
', 'CreateRegistryResponse$RegistryName' => 'The name of the registry.
', 'CreateSchemaInput$SchemaName' => 'Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
', 'CreateSchemaResponse$RegistryName' => 'The name of the registry.
', 'CreateSchemaResponse$SchemaName' => 'The name of the schema.
', 'DeleteRegistryResponse$RegistryName' => 'The name of the registry being deleted.
', 'DeleteSchemaResponse$SchemaName' => 'The name of the schema being deleted.
', 'GetRegistryResponse$RegistryName' => 'The name of the registry.
', 'GetSchemaResponse$RegistryName' => 'The name of the registry.
', 'GetSchemaResponse$SchemaName' => 'The name of the schema.
', 'PutSchemaVersionMetadataResponse$SchemaName' => 'The name for the schema.
', 'PutSchemaVersionMetadataResponse$RegistryName' => 'The name for the registry.
', 'RegistryId$RegistryName' => 'Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.
The name of the registry.
', 'RemoveSchemaVersionMetadataResponse$SchemaName' => 'The name of the schema.
', 'RemoveSchemaVersionMetadataResponse$RegistryName' => 'The name of the registry.
', 'SchemaId$SchemaName' => 'The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
', 'SchemaListItem$RegistryName' => 'the name of the registry where the schema resides.
', 'SchemaListItem$SchemaName' => 'The name of the schema.
', 'UpdateRegistryResponse$RegistryName' => 'The name of the updated registry.
', 'UpdateSchemaResponse$SchemaName' => 'The name of the schema.
', 'UpdateSchemaResponse$RegistryName' => 'The name of the registry that contains the schema.
', ], ], 'SchemaRegistryTokenString' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListRegistriesResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'ListSchemaVersionsInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListSchemaVersionsResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'ListSchemasInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListSchemasResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'QuerySchemaVersionMetadataInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'QuerySchemaVersionMetadataResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', ], ], 'SchemaStatus' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$SchemaStatus' => 'The status of the schema.
', 'DeleteSchemaResponse$Status' => 'The status of the schema.
', 'GetSchemaResponse$SchemaStatus' => 'The status of the schema.
', 'SchemaListItem$SchemaStatus' => 'The status of the schema.
', ], ], 'SchemaValidationError' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityResponse$Error' => 'A validation failure error message.
', ], ], 'SchemaVersionErrorItem' => [ 'base' => 'An object that contains the error details for an operation on a schema version.
', 'refs' => [ 'SchemaVersionErrorList$member' => NULL, ], ], 'SchemaVersionErrorList' => [ 'base' => NULL, 'refs' => [ 'DeleteSchemaVersionsResponse$SchemaVersionErrors' => 'A list of SchemaVersionErrorItem objects, each containing an error and schema version.
The unique identifier of the first schema version.
', 'GetSchemaByDefinitionResponse$SchemaVersionId' => 'The schema ID of the schema version.
', 'GetSchemaVersionInput$SchemaVersionId' => 'The SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.
The SchemaVersionId of the schema version.
The unique version ID of the schema version.
', 'PutSchemaVersionMetadataResponse$SchemaVersionId' => 'The unique version ID of the schema version.
', 'QuerySchemaVersionMetadataInput$SchemaVersionId' => 'The unique version ID of the schema version.
', 'QuerySchemaVersionMetadataResponse$SchemaVersionId' => 'The unique version ID of the schema version.
', 'RegisterSchemaVersionResponse$SchemaVersionId' => 'The unique ID that represents the version of this schema.
', 'RemoveSchemaVersionMetadataInput$SchemaVersionId' => 'The unique version ID of the schema version.
', 'RemoveSchemaVersionMetadataResponse$SchemaVersionId' => 'The version ID for the schema version.
', 'SchemaReference$SchemaVersionId' => 'The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
The unique identifier of the schema version.
', ], ], 'SchemaVersionList' => [ 'base' => NULL, 'refs' => [ 'ListSchemaVersionsResponse$Schemas' => 'An array of SchemaVersionList objects containing details of each schema version.
An object containing the details about a schema version.
', 'refs' => [ 'SchemaVersionList$member' => NULL, ], ], 'SchemaVersionNumber' => [ 'base' => 'A structure containing the schema version information.
', 'refs' => [ 'GetSchemaVersionInput$SchemaVersionNumber' => 'The version number of the schema.
', 'GetSchemaVersionsDiffInput$FirstSchemaVersionNumber' => 'The first of the two schema versions to be compared.
', 'GetSchemaVersionsDiffInput$SecondSchemaVersionNumber' => 'The second of the two schema versions to be compared.
', 'PutSchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'QuerySchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'RemoveSchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'UpdateSchemaInput$SchemaVersionNumber' => 'Version number required for check pointing. One of VersionNumber or Compatibility has to be provided.
The status of the first schema version created.
', 'GetSchemaByDefinitionResponse$Status' => 'The status of the schema version.
', 'GetSchemaVersionResponse$Status' => 'The status of the schema version.
', 'RegisterSchemaVersionResponse$Status' => 'The status of the schema version.
', 'SchemaVersionListItem$Status' => 'The status of the schema version.
', ], ], 'ScriptLocationString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$ScriptLocation' => 'Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
', ], ], 'SearchPropertyPredicates' => [ 'base' => NULL, 'refs' => [ 'SearchTablesRequest$Filters' => 'A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.
Specifies a security configuration.
', 'refs' => [ 'GetSecurityConfigurationResponse$SecurityConfiguration' => 'The requested security configuration.
', 'SecurityConfigurationList$member' => NULL, ], ], 'SecurityConfigurationList' => [ 'base' => NULL, 'refs' => [ 'GetSecurityConfigurationsResponse$SecurityConfigurations' => 'A list of security configurations.
', ], ], 'SecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'PhysicalConnectionRequirements$SecurityGroupIdList' => 'The security group ID list used by the connection.
', ], ], 'Segment' => [ 'base' => 'Defines a non-overlapping region of a table\'s partitions, allowing multiple requests to be run in parallel.
', 'refs' => [ 'GetPartitionsRequest$Segment' => 'The segment of the table\'s partitions to scan in this request.
', 'GetUnfilteredPartitionsMetadataRequest$Segment' => 'The segment of the table\'s partitions to scan in this request.
', ], ], 'SelectFields' => [ 'base' => 'Specifies a transform that chooses the data property keys that you want to keep.
', 'refs' => [ 'CodeGenConfigurationNode$SelectFields' => 'Specifies a transform that chooses the data property keys that you want to keep.
', ], ], 'SelectFromCollection' => [ 'base' => 'Specifies a transform that chooses one DynamicFrame from a collection of DynamicFrames. The output is the selected DynamicFrame
Specifies a transform that chooses one DynamicFrame from a collection of DynamicFrames. The output is the selected DynamicFrame
Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.
', ], ], 'SerDeInfo' => [ 'base' => 'Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
', 'refs' => [ 'StorageDescriptor$SerdeInfo' => 'The serialization/deserialization (SerDe) information.
', ], ], 'Session' => [ 'base' => 'The period in which a remote Spark runtime environment is running.
', 'refs' => [ 'CreateSessionResponse$Session' => 'Returns the session object in the response.
', 'GetSessionResponse$Session' => 'The session object is returned in the response.
', 'SessionList$member' => NULL, ], ], 'SessionCommand' => [ 'base' => 'The SessionCommand that runs the job.
The SessionCommand that runs the job.
The command object.See SessionCommand.
', ], ], 'SessionIdList' => [ 'base' => NULL, 'refs' => [ 'ListSessionsResponse$Ids' => 'Returns the ID of the session.
', ], ], 'SessionList' => [ 'base' => NULL, 'refs' => [ 'ListSessionsResponse$Sessions' => 'Returns the session object.
', ], ], 'SessionStatus' => [ 'base' => NULL, 'refs' => [ 'Session$Status' => 'The session status.
', ], ], 'SkewedInfo' => [ 'base' => 'Specifies skewed values in a table. Skewed values are those that occur with very high frequency.
', 'refs' => [ 'StorageDescriptor$SkewedInfo' => 'The information about values that appear frequently in a column (skewed values).
', ], ], 'SnowflakeNodeData' => [ 'base' => 'Specifies configuration for Snowflake nodes in Glue Studio.
', 'refs' => [ 'SnowflakeSource$Data' => 'Configuration for the Snowflake data source.
', 'SnowflakeTarget$Data' => 'Specifies the data of the Snowflake target node.
', ], ], 'SnowflakeSource' => [ 'base' => 'Specifies a Snowflake data source.
', 'refs' => [ 'CodeGenConfigurationNode$SnowflakeSource' => 'Specifies a Snowflake data source.
', ], ], 'SnowflakeTarget' => [ 'base' => 'Specifies a Snowflake target.
', 'refs' => [ 'CodeGenConfigurationNode$SnowflakeTarget' => 'Specifies a target that writes to a Snowflake data source.
', ], ], 'Sort' => [ 'base' => NULL, 'refs' => [ 'SortCriterion$Sort' => 'An ascending or descending sort.
', ], ], 'SortCriteria' => [ 'base' => NULL, 'refs' => [ 'SearchTablesRequest$SortCriteria' => 'A list of criteria for sorting the results by a field name, in an ascending or descending order.
', ], ], 'SortCriterion' => [ 'base' => 'Specifies a field to sort by and a sort order.
', 'refs' => [ 'SortCriteria$member' => NULL, ], ], 'SortDirectionType' => [ 'base' => NULL, 'refs' => [ 'TaskRunSortCriteria$SortDirection' => 'The sort direction to be used to sort the list of task runs for the machine learning transform.
', 'TransformSortCriteria$SortDirection' => 'The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
', ], ], 'SourceControlAuthStrategy' => [ 'base' => NULL, 'refs' => [ 'SourceControlDetails$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', 'UpdateJobFromSourceControlRequest$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', 'UpdateSourceControlFromJobRequest$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', ], ], 'SourceControlDetails' => [ 'base' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'refs' => [ 'CreateJobRequest$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'Job$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'JobUpdate$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', ], ], 'SourceControlProvider' => [ 'base' => NULL, 'refs' => [ 'SourceControlDetails$Provider' => 'The provider for the remote repository.
', 'UpdateJobFromSourceControlRequest$Provider' => 'The provider for the remote repository.
', 'UpdateSourceControlFromJobRequest$Provider' => 'The provider for the remote repository.
', ], ], 'SparkConnectorSource' => [ 'base' => 'Specifies a connector to an Apache Spark data source.
', 'refs' => [ 'CodeGenConfigurationNode$SparkConnectorSource' => 'Specifies a connector to an Apache Spark data source.
', ], ], 'SparkConnectorTarget' => [ 'base' => 'Specifies a target that uses an Apache Spark connector.
', 'refs' => [ 'CodeGenConfigurationNode$SparkConnectorTarget' => 'Specifies a target that uses an Apache Spark connector.
', ], ], 'SparkSQL' => [ 'base' => 'Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame.
Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame.
Specifies a transform that writes samples of the data to an Amazon S3 bucket.
', 'refs' => [ 'CodeGenConfigurationNode$Spigot' => 'Specifies a transform that writes samples of the data to an Amazon S3 bucket.
', ], ], 'SplitFields' => [ 'base' => 'Specifies a transform that splits data property keys into two DynamicFrames. The output is a collection of DynamicFrames: one with selected data property keys, and one with the remaining data property keys.
Specifies a transform that splits data property keys into two DynamicFrames. The output is a collection of DynamicFrames: one with selected data property keys, and one with the remaining data property keys.
Represents a single entry in the list of values for SqlAliases.
A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify From as MyDataSource, and Alias as SqlName, then in your SQL you can do:
select * from SqlName
and that gets data from MyDataSource.
', ], ], 'SqlQuery' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorSource$Query' => 'The table or SQL query to get the data from. You can specify either ConnectionTable or query, but not both.
A SQL query that must use Spark SQL syntax and return a single data set.
', ], ], 'StartBlueprintRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartBlueprintRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartExportLabelsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartExportLabelsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartImportLabelsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartImportLabelsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartJobRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartJobRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMLEvaluationTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMLEvaluationTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMLLabelingSetGenerationTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMLLabelingSetGenerationTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartingEventBatchCondition' => [ 'base' => 'The batch condition that started the workflow run. Either the number of events in the batch size arrived, in which case the BatchSize member is non-zero, or the batch window expired, in which case the BatchWindow member is non-zero.
', 'refs' => [ 'WorkflowRun$StartingEventBatchCondition' => 'The batch condition that started the workflow run.
', ], ], 'StartingPosition' => [ 'base' => NULL, 'refs' => [ 'KinesisStreamingSourceOptions$StartingPosition' => 'The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest".
Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
', ], ], 'Statement' => [ 'base' => 'The statement or request for a particular action to occur in a session.
', 'refs' => [ 'GetStatementResponse$Statement' => 'Returns the statement.
', 'StatementList$member' => NULL, ], ], 'StatementList' => [ 'base' => NULL, 'refs' => [ 'ListStatementsResponse$Statements' => 'Returns the list of statements.
', ], ], 'StatementOutput' => [ 'base' => 'The code execution output in JSON format.
', 'refs' => [ 'Statement$Output' => 'The output in JSON.
', ], ], 'StatementOutputData' => [ 'base' => 'The code execution output in JSON format.
', 'refs' => [ 'StatementOutput$Data' => 'The code execution output.
', ], ], 'StatementState' => [ 'base' => NULL, 'refs' => [ 'Statement$State' => 'The state while request is actioned.
', 'StatementOutput$Status' => 'The status of the code execution output.
', ], ], 'StopCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StorageDescriptor' => [ 'base' => 'Describes the physical storage of table data.
', 'refs' => [ 'Partition$StorageDescriptor' => 'Provides information about the physical location where the partition is stored.
', 'PartitionInput$StorageDescriptor' => 'Provides information about the physical location where the partition is stored.
', 'Table$StorageDescriptor' => 'A storage descriptor containing information about the physical storage of this table.
', 'TableInput$StorageDescriptor' => 'A storage descriptor containing information about the physical storage of this table.
', ], ], 'StreamingDataPreviewOptions' => [ 'base' => 'Specifies options related to data preview for viewing a sample of your data.
', 'refs' => [ 'CatalogKafkaSource$DataPreviewOptions' => 'Specifies options related to data preview for viewing a sample of your data.
', 'CatalogKinesisSource$DataPreviewOptions' => 'Additional options for data preview.
', 'DirectKafkaSource$DataPreviewOptions' => 'Specifies options related to data preview for viewing a sample of your data.
', 'DirectKinesisSource$DataPreviewOptions' => 'Additional options for data preview.
', ], ], 'StringColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for character sequence data values.
', 'refs' => [ 'ColumnStatisticsData$StringColumnStatisticsData' => 'String column statistics data.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$SecurityGroupIds' => 'Security group IDs for the security groups to be used by the new DevEndpoint.
The security groups assigned to the new DevEndpoint.
A list of security group identifiers used in this DevEndpoint.
The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint.
Represents a collection of related data organized in columns and rows.
', 'refs' => [ 'GetTableResponse$Table' => 'The Table object that defines the specified table.
A Table object containing the table metadata.
', 'TableList$member' => NULL, 'TableVersion$Table' => 'The table in question.
', ], ], 'TableError' => [ 'base' => 'An error record for table operations.
', 'refs' => [ 'TableErrors$member' => NULL, ], ], 'TableErrors' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableResponse$Errors' => 'A list of errors encountered in attempting to delete the specified tables.
', ], ], 'TableIdentifier' => [ 'base' => 'A structure that describes a target table for resource linking.
', 'refs' => [ 'Table$TargetTable' => 'A TableIdentifier structure that describes a target table for resource linking.
A TableIdentifier structure that describes a target table for resource linking.
A structure used to define a table.
', 'refs' => [ 'CreateTableRequest$TableInput' => 'The TableInput object that defines the metadata table to create in the catalog.
An updated TableInput object to define the metadata table in the catalog.
A list of the requested Table objects.
A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.
The name of the source table.
', 'MappingEntry$TargetTable' => 'The target table.
', ], ], 'TablePrefix' => [ 'base' => NULL, 'refs' => [ 'Crawler$TablePrefix' => 'The prefix added to the names of tables that are created.
', 'CreateCrawlerRequest$TablePrefix' => 'The table prefix used for catalog tables that are created.
', 'UpdateCrawlerRequest$TablePrefix' => 'The table prefix used for catalog tables that are created.
', ], ], 'TableTypeString' => [ 'base' => NULL, 'refs' => [ 'Table$TableType' => 'The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Specifies a version of a table.
', 'refs' => [ 'GetTableVersionResponse$TableVersion' => 'The requested table version.
', 'GetTableVersionsList$member' => NULL, ], ], 'TableVersionError' => [ 'base' => 'An error record for table-version operations.
', 'refs' => [ 'TableVersionErrors$member' => NULL, ], ], 'TableVersionErrors' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionResponse$Errors' => 'A list of errors encountered while trying to delete the specified table versions.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeysList$member' => NULL, 'TagsMap$key' => NULL, ], ], 'TagKeysList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagsToRemove' => 'Tags to remove from this resource.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagsMap$value' => NULL, ], ], 'TagsMap' => [ 'base' => NULL, 'refs' => [ 'CreateBlueprintRequest$Tags' => 'The tags to be applied to this blueprint.
', 'CreateConnectionRequest$Tags' => 'The tags you assign to the connection.
', 'CreateCrawlerRequest$Tags' => 'The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateCustomEntityTypeRequest$Tags' => 'A list of tags applied to the custom entity type.
', 'CreateDataQualityRulesetRequest$Tags' => 'A list of tags applied to the data quality ruleset.
', 'CreateDatabaseRequest$Tags' => 'The tags you assign to the database.
', 'CreateDevEndpointRequest$Tags' => 'The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateJobRequest$Tags' => 'The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateMLTransformRequest$Tags' => 'The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateRegistryInput$Tags' => 'Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
', 'CreateRegistryResponse$Tags' => 'The tags for the registry.
', 'CreateSchemaInput$Tags' => 'Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
', 'CreateSchemaResponse$Tags' => 'The tags for the schema.
', 'CreateSessionRequest$Tags' => 'The map of key value pairs (tags) belonging to the session.
', 'CreateTriggerRequest$Tags' => 'The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateWorkflowRequest$Tags' => 'The tags to be used with this workflow.
', 'GetTagsResponse$Tags' => 'The requested tags.
', 'ListBlueprintsRequest$Tags' => 'Filters the list by an Amazon Web Services resource tag.
', 'ListCrawlersRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListCustomEntityTypesRequest$Tags' => 'A list of key-value pair tags.
', 'ListDataQualityRulesetsRequest$Tags' => 'A list of key-value pair tags.
', 'ListDevEndpointsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListJobsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListMLTransformsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListSessionsRequest$Tags' => 'Tags belonging to the session.
', 'ListTriggersRequest$Tags' => 'Specifies to return only these tagged resources.
', 'TagResourceRequest$TagsToAdd' => 'Tags to add to this resource.
', ], ], 'TargetFormat' => [ 'base' => NULL, 'refs' => [ 'S3DeltaDirectTarget$Format' => 'Specifies the data output format for the target.
', 'S3DirectTarget$Format' => 'Specifies the data output format for the target.
', 'S3HudiDirectTarget$Format' => 'Specifies the data output format for the target.
', ], ], 'TaskRun' => [ 'base' => 'The sampling parameters that are associated with the machine learning transform.
', 'refs' => [ 'TaskRunList$member' => NULL, ], ], 'TaskRunFilterCriteria' => [ 'base' => 'The criteria that are used to filter the task runs for the machine learning transform.
', 'refs' => [ 'GetMLTaskRunsRequest$Filter' => 'The filter criteria, in the TaskRunFilterCriteria structure, for the task run.
A list of task runs that are associated with the transform.
', ], ], 'TaskRunProperties' => [ 'base' => 'The configuration properties for the task run.
', 'refs' => [ 'GetMLTaskRunResponse$Properties' => 'The list of properties that are associated with the task run.
', 'TaskRun$Properties' => 'Specifies configuration properties associated with this task run.
', ], ], 'TaskRunSortColumnType' => [ 'base' => NULL, 'refs' => [ 'TaskRunSortCriteria$Column' => 'The column to be used to sort the list of task runs for the machine learning transform.
', ], ], 'TaskRunSortCriteria' => [ 'base' => 'The sorting criteria that are used to sort the list of task runs for the machine learning transform.
', 'refs' => [ 'GetMLTaskRunsRequest$Sort' => 'The sorting criteria, in the TaskRunSortCriteria structure, for the task run.
The status for this run.
', 'DataQualityRuleRecommendationRunDescription$Status' => 'The status for this run.
', 'DataQualityRulesetEvaluationRunDescription$Status' => 'The status for this run.
', 'GetDataQualityRuleRecommendationRunResponse$Status' => 'The status for this run.
', 'GetDataQualityRulesetEvaluationRunResponse$Status' => 'The status for this run.
', 'GetMLTaskRunResponse$Status' => 'The status for this task run.
', 'TaskRun$Status' => 'The current status of the requested task run.
', 'TaskRunFilterCriteria$Status' => 'The current status of the task run.
', ], ], 'TaskType' => [ 'base' => NULL, 'refs' => [ 'TaskRunFilterCriteria$TaskRunType' => 'The type of task run.
', 'TaskRunProperties$TaskType' => 'The type of task run.
', ], ], 'Timeout' => [ 'base' => NULL, 'refs' => [ 'Action$Timeout' => 'The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the documentation for other job types.
', 'CreateSessionRequest$IdleTimeout' => 'The number of minutes when idle before session times out. Default for Spark ETL jobs is value of Timeout. Consult the documentation for other job types.
', 'GetDataQualityRuleRecommendationRunResponse$Timeout' => 'The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.
Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
', 'JobUpdate$Timeout' => 'The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout in minutes of the machine learning transform.
', 'StartDataQualityRuleRecommendationRunRequest$Timeout' => 'The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.
Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
', 'UpdateMLTransformRequest$Timeout' => 'The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The time that the migration was started.
', 'ColumnStatistics$AnalyzedTime' => 'The timestamp of when column statistics were generated.
', 'Connection$CreationTime' => 'The time that this connection definition was created.
', 'Connection$LastUpdatedTime' => 'The last time that this connection definition was updated.
', 'Crawler$CreationTime' => 'The time that the crawler was created.
', 'Crawler$LastUpdated' => 'The time that the crawler was last updated.
', 'CrawlerHistory$StartTime' => 'The date and time on which the crawl started.
', 'CrawlerHistory$EndTime' => 'The date and time on which the crawl ended.
', 'CsvClassifier$CreationTime' => 'The time that this classifier was registered.
', 'CsvClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'DataQualityResult$StartedOn' => 'The date and time when this data quality run started.
', 'DataQualityResult$CompletedOn' => 'The date and time when this data quality run completed.
', 'DataQualityResultDescription$StartedOn' => 'The time that the run started for this data quality result.
', 'DataQualityResultFilterCriteria$StartedAfter' => 'Filter results by runs that started after this time.
', 'DataQualityResultFilterCriteria$StartedBefore' => 'Filter results by runs that started before this time.
', 'DataQualityRuleRecommendationRunDescription$StartedOn' => 'The date and time when this run started.
', 'DataQualityRuleRecommendationRunFilter$StartedBefore' => 'Filter based on time for results started before provided time.
', 'DataQualityRuleRecommendationRunFilter$StartedAfter' => 'Filter based on time for results started after provided time.
', 'DataQualityRulesetEvaluationRunDescription$StartedOn' => 'The date and time when the run started.
', 'DataQualityRulesetEvaluationRunFilter$StartedBefore' => 'Filter results by runs that started before this time.
', 'DataQualityRulesetEvaluationRunFilter$StartedAfter' => 'Filter results by runs that started after this time.
', 'DataQualityRulesetFilterCriteria$CreatedBefore' => 'Filter on rulesets created before this date.
', 'DataQualityRulesetFilterCriteria$CreatedAfter' => 'Filter on rulesets created after this date.
', 'DataQualityRulesetFilterCriteria$LastModifiedBefore' => 'Filter on rulesets last modified before this date.
', 'DataQualityRulesetFilterCriteria$LastModifiedAfter' => 'Filter on rulesets last modified after this date.
', 'DataQualityRulesetListDetails$CreatedOn' => 'The date and time the data quality ruleset was created.
', 'DataQualityRulesetListDetails$LastModifiedOn' => 'The date and time the data quality ruleset was last modified.
', 'Database$CreateTime' => 'The time at which the metadata database was created in the catalog.
', 'DateColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DateColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', 'GetDataQualityResultResponse$StartedOn' => 'The date and time when the run for this data quality result started.
', 'GetDataQualityResultResponse$CompletedOn' => 'The date and time when the run for this data quality result was completed.
', 'GetDataQualityRuleRecommendationRunResponse$StartedOn' => 'The date and time when this run started.
', 'GetDataQualityRuleRecommendationRunResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality rule recommendation run was modified.
', 'GetDataQualityRuleRecommendationRunResponse$CompletedOn' => 'The date and time when this run was completed.
', 'GetDataQualityRulesetEvaluationRunResponse$StartedOn' => 'The date and time when this run started.
', 'GetDataQualityRulesetEvaluationRunResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality rule recommendation run was modified.
', 'GetDataQualityRulesetEvaluationRunResponse$CompletedOn' => 'The date and time when this run was completed.
', 'GetDataQualityRulesetResponse$CreatedOn' => 'A timestamp. The time and date that this data quality ruleset was created.
', 'GetDataQualityRulesetResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality ruleset was modified.
', 'GetMLTaskRunResponse$StartedOn' => 'The date and time when this task run started.
', 'GetMLTaskRunResponse$LastModifiedOn' => 'The date and time when this task run was last modified.
', 'GetMLTaskRunResponse$CompletedOn' => 'The date and time when this task run was completed.
', 'GetMLTransformResponse$CreatedOn' => 'The date and time when the transform was created.
', 'GetMLTransformResponse$LastModifiedOn' => 'The date and time when the transform was last modified.
', 'GetPartitionsRequest$QueryAsOfTime' => 'The time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
The date and time at which the policy was created.
', 'GetResourcePolicyResponse$UpdateTime' => 'The date and time at which the policy was last updated.
', 'GetTableRequest$QueryAsOfTime' => 'The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
The date and time at which the policy was created.
', 'GluePolicy$UpdateTime' => 'The date and time at which the policy was last updated.
', 'GrokClassifier$CreationTime' => 'The time that this classifier was registered.
', 'GrokClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'JsonClassifier$CreationTime' => 'The time that this classifier was registered.
', 'JsonClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'LastCrawlInfo$StartTime' => 'The time at which the crawl started.
', 'MLTransform$CreatedOn' => 'A timestamp. The time and date that this machine learning transform was created.
', 'MLTransform$LastModifiedOn' => 'A timestamp. The last point in time when this machine learning transform was modified.
', 'Partition$CreationTime' => 'The time at which the partition was created.
', 'Partition$LastAccessTime' => 'The last time at which the partition was accessed.
', 'Partition$LastAnalyzedTime' => 'The last time at which column statistics were computed for this partition.
', 'PartitionInput$LastAccessTime' => 'The last time at which the partition was accessed.
', 'PartitionInput$LastAnalyzedTime' => 'The last time at which column statistics were computed for this partition.
', 'Table$CreateTime' => 'The time when the table definition was created in the Data Catalog.
', 'Table$UpdateTime' => 'The last time that the table was updated.
', 'Table$LastAccessTime' => 'The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
', 'Table$LastAnalyzedTime' => 'The last time that column statistics were computed for this table.
', 'TableInput$LastAccessTime' => 'The last time that the table was accessed.
', 'TableInput$LastAnalyzedTime' => 'The last time that column statistics were computed for this table.
', 'TaskRun$StartedOn' => 'The date and time that this task run started.
', 'TaskRun$LastModifiedOn' => 'The last point in time that the requested task run was updated.
', 'TaskRun$CompletedOn' => 'The last point in time that the requested task run was completed.
', 'TaskRunFilterCriteria$StartedBefore' => 'Filter on task runs started before this date.
', 'TaskRunFilterCriteria$StartedAfter' => 'Filter on task runs started after this date.
', 'TransformFilterCriteria$CreatedBefore' => 'The time and date before which the transforms were created.
', 'TransformFilterCriteria$CreatedAfter' => 'The time and date after which the transforms were created.
', 'TransformFilterCriteria$LastModifiedBefore' => 'Filter on transforms last modified before this date.
', 'TransformFilterCriteria$LastModifiedAfter' => 'Filter on transforms last modified after this date.
', 'UserDefinedFunction$CreateTime' => 'The time at which the function was created.
', 'XMLClassifier$CreationTime' => 'The time that this classifier was registered.
', 'XMLClassifier$LastUpdated' => 'The time that this classifier was last updated.
', ], ], 'TimestampValue' => [ 'base' => NULL, 'refs' => [ 'Blueprint$CreatedOn' => 'The date and time the blueprint was registered.
', 'Blueprint$LastModifiedOn' => 'The date and time the blueprint was last modified.
', 'BlueprintRun$StartedOn' => 'The date and time that the blueprint run started.
', 'BlueprintRun$CompletedOn' => 'The date and time that the blueprint run completed.
', 'Crawl$StartedOn' => 'The date and time on which the crawl started.
', 'Crawl$CompletedOn' => 'The date and time on which the crawl completed.
', 'CreateDevEndpointResponse$CreatedTimestamp' => 'The point in time at which this DevEndpoint was created.
The time at which the new security configuration was created.
', 'DevEndpoint$CreatedTimestamp' => 'The point in time at which this DevEndpoint was created.
', 'DevEndpoint$LastModifiedTimestamp' => 'The point in time at which this DevEndpoint was last modified.
The time and date that this job definition was created.
', 'Job$LastModifiedOn' => 'The last point in time when this job definition was modified.
', 'JobRun$StartedOn' => 'The date and time at which this job run was started.
', 'JobRun$LastModifiedOn' => 'The last time that this job run was modified.
', 'JobRun$CompletedOn' => 'The date and time that this job run completed.
', 'LastActiveDefinition$LastModifiedOn' => 'The date and time the blueprint was last modified.
', 'SecurityConfiguration$CreatedTimeStamp' => 'The time at which this security configuration was created.
', 'Session$CreatedOn' => 'The time and date when the session was created.
', 'Workflow$CreatedOn' => 'The date and time when the workflow was created.
', 'Workflow$LastModifiedOn' => 'The date and time when the workflow was last modified.
', 'WorkflowRun$StartedOn' => 'The date and time when the workflow run was started.
', 'WorkflowRun$CompletedOn' => 'The date and time when the workflow run completed.
', ], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'GetClassifiersRequest$NextToken' => 'An optional continuation token.
', 'GetClassifiersResponse$NextToken' => 'A continuation token.
', 'GetConnectionsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetConnectionsResponse$NextToken' => 'A continuation token, if the list of connections returned does not include the last of the filtered connections.
', 'GetCrawlerMetricsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetCrawlerMetricsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'GetCrawlersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'GetCrawlersResponse$NextToken' => 'A continuation token, if the returned list has not reached the end of those defined in this customer account.
', 'GetDatabasesRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetDatabasesResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'GetPartitionIndexesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'GetPartitionIndexesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', 'GetPartitionsRequest$NextToken' => 'A continuation token, if this is not the first call to retrieve these partitions.
', 'GetPartitionsResponse$NextToken' => 'A continuation token, if the returned list of partitions does not include the last one.
', 'GetResourcePoliciesRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'GetResourcePoliciesResponse$NextToken' => 'A continuation token, if the returned list does not contain the last resource policy available.
', 'GetTableVersionsRequest$NextToken' => 'A continuation token, if this is not the first call.
', 'GetTableVersionsResponse$NextToken' => 'A continuation token, if the list of available versions does not include the last one.
', 'GetTablesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'GetTablesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', 'GetUnfilteredPartitionsMetadataRequest$NextToken' => 'A continuation token, if this is not the first call to retrieve these partitions.
', 'GetUnfilteredPartitionsMetadataResponse$NextToken' => 'A continuation token, if the returned list of partitions does not include the last one.
', 'GetUserDefinedFunctionsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetUserDefinedFunctionsResponse$NextToken' => 'A continuation token, if the list of functions returned does not include the last requested function.
', 'ListCrawlersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListCrawlersResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListCrawlsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListCrawlsResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'SearchTablesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'SearchTablesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', ], ], 'Topk' => [ 'base' => NULL, 'refs' => [ 'Spigot$Topk' => 'Specifies a number of records to write starting from the beginning of the dataset.
', ], ], 'TotalSegmentsInteger' => [ 'base' => NULL, 'refs' => [ 'Segment$TotalSegments' => 'The total number of segments.
', ], ], 'TransactionIdString' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableRequest$TransactionId' => 'The transaction ID at which to delete the table contents.
', 'CreateTableRequest$TransactionId' => 'The ID of the transaction.
', 'DeleteTableRequest$TransactionId' => 'The transaction ID at which to delete the table contents.
', 'GetPartitionsRequest$TransactionId' => 'The transaction ID at which to read the partition contents.
', 'GetTableRequest$TransactionId' => 'The transaction ID at which to read the table contents.
', 'GetTablesRequest$TransactionId' => 'The transaction ID at which to read the table contents.
', 'UpdateTableRequest$TransactionId' => 'The transaction ID at which to update the table contents.
', ], ], 'TransformConfigParameter' => [ 'base' => 'Specifies the parameters in the config file of the dynamic transform.
', 'refs' => [ 'TransformConfigParameterList$member' => NULL, ], ], 'TransformConfigParameterList' => [ 'base' => NULL, 'refs' => [ 'DynamicTransform$Parameters' => 'Specifies the parameters of the dynamic transform.
', ], ], 'TransformEncryption' => [ 'base' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.
', 'refs' => [ 'CreateMLTransformRequest$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', 'GetMLTransformResponse$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', 'MLTransform$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', ], ], 'TransformFilterCriteria' => [ 'base' => 'The criteria used to filter the machine learning transforms.
', 'refs' => [ 'GetMLTransformsRequest$Filter' => 'The filter transformation criteria.
', 'ListMLTransformsRequest$Filter' => 'A TransformFilterCriteria used to filter the machine learning transforms.
The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.
', ], ], 'TransformList' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformsResponse$Transforms' => 'A list of machine learning transforms.
', ], ], 'TransformParameters' => [ 'base' => 'The algorithm-specific parameters that are associated with the machine learning transform.
', 'refs' => [ 'CreateMLTransformRequest$Parameters' => 'The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
', 'GetMLTransformResponse$Parameters' => 'The configuration parameters that are specific to the algorithm used.
', 'MLTransform$Parameters' => 'A TransformParameters object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.
', ], ], 'TransformSchema' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformResponse$Schema' => 'The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.
A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
', 'TransformFilterCriteria$Schema' => 'Filters on datasets with a specific schema. The Map<Column, Type> object is an array of key-value pairs representing the schema this transform accepts, where Column is the name of a column, and Type is the type of the data such as an integer or string. Has an upper bound of 100 columns.
The column to be used in the sorting criteria that are associated with the machine learning transform.
', ], ], 'TransformSortCriteria' => [ 'base' => 'The sorting criteria that are associated with the machine learning transform.
', 'refs' => [ 'GetMLTransformsRequest$Sort' => 'The sorting criteria.
', 'ListMLTransformsRequest$Sort' => 'A TransformSortCriteria used to sort the machine learning transforms.
The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
', 'MLTransform$Status' => 'The current status of the machine learning transform.
', 'TransformFilterCriteria$Status' => 'Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
', ], ], 'TransformType' => [ 'base' => NULL, 'refs' => [ 'EvaluationMetrics$TransformType' => 'The type of machine learning transform.
', 'TransformFilterCriteria$TransformType' => 'The type of machine learning transform that is used to filter the machine learning transforms.
', 'TransformParameters$TransformType' => 'The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
', ], ], 'Trigger' => [ 'base' => 'Information about a specific trigger.
', 'refs' => [ 'GetTriggerResponse$Trigger' => 'The requested trigger definition.
', 'TriggerList$member' => NULL, 'TriggerNodeDetails$Trigger' => 'The information of the trigger represented by the trigger node.
', 'UpdateTriggerResponse$Trigger' => 'The resulting trigger definition.
', ], ], 'TriggerList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTriggersResponse$Triggers' => 'A list of trigger definitions.
', 'GetTriggersResponse$Triggers' => 'A list of triggers for the specified job.
', ], ], 'TriggerNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTriggersRequest$TriggerNames' => 'A list of trigger names, which may be the names returned from the ListTriggers operation.
A list of names of triggers not found.
', 'ListTriggersResponse$TriggerNames' => 'The names of all triggers in the account, or the triggers with the specified tags.
', ], ], 'TriggerNodeDetails' => [ 'base' => 'The details of a Trigger node present in the workflow.
', 'refs' => [ 'Node$TriggerDetails' => 'Details of the Trigger when the node represents a Trigger.
', ], ], 'TriggerState' => [ 'base' => NULL, 'refs' => [ 'Trigger$State' => 'The current state of the trigger.
', ], ], 'TriggerType' => [ 'base' => NULL, 'refs' => [ 'CreateTriggerRequest$Type' => 'The type of the new trigger.
', 'Trigger$Type' => 'The type of trigger that this is.
', ], ], 'TriggerUpdate' => [ 'base' => 'A structure used to provide information used to update a trigger. This object updates the previous trigger definition by overwriting it completely.
', 'refs' => [ 'UpdateTriggerRequest$TriggerUpdate' => 'The new values with which to update the trigger.
', ], ], 'TwoInputs' => [ 'base' => NULL, 'refs' => [ 'Join$Inputs' => 'The data inputs identified by their node names.
', 'Merge$Inputs' => 'The data inputs identified by their node names.
', 'Union$Inputs' => 'The node ID inputs to the transform.
', ], ], 'TypeString' => [ 'base' => NULL, 'refs' => [ 'ColumnStatistics$ColumnType' => 'The data type of the column.
', ], ], 'URI' => [ 'base' => NULL, 'refs' => [ 'Database$LocationUri' => 'The location of the database (for example, an HDFS path).
', 'DatabaseInput$LocationUri' => 'The location of the database (for example, an HDFS path).
', 'ResourceUri$Uri' => 'The URI for accessing the resource.
', ], ], 'UnfilteredPartition' => [ 'base' => 'A partition that contains unfiltered metadata.
', 'refs' => [ 'UnfilteredPartitionList$member' => NULL, ], ], 'UnfilteredPartitionList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredPartitionsMetadataResponse$UnfilteredPartitions' => 'A list of requested partitions.
', ], ], 'Union' => [ 'base' => 'Specifies a transform that combines the rows from two or more datasets into a single result.
', 'refs' => [ 'CodeGenConfigurationNode$Union' => 'Specifies a transform that combines the rows from two or more datasets into a single result.
', ], ], 'UnionType' => [ 'base' => NULL, 'refs' => [ 'Union$UnionType' => 'Indicates the type of Union transform.
Specify ALL to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.
Specify DISTINCT to remove duplicate rows in the resulting DynamicFrame.
The update behavior when the crawler finds a changed schema.
', ], ], 'UpdateBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCatalogBehavior' => [ 'base' => NULL, 'refs' => [ 'CatalogSchemaChangePolicy$UpdateBehavior' => 'The update behavior when the crawler finds a changed schema.
', 'DirectSchemaChangePolicy$UpdateBehavior' => 'The update behavior when the crawler finds a changed schema.
', ], ], 'UpdateClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsList' => [ 'base' => NULL, 'refs' => [ 'UpdateColumnStatisticsForPartitionRequest$ColumnStatisticsList' => 'A list of the column statistics.
', 'UpdateColumnStatisticsForTableRequest$ColumnStatisticsList' => 'A list of the column statistics.
', ], ], 'UpdateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCsvClassifierRequest' => [ 'base' => 'Specifies a custom CSV classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$CsvClassifier' => 'A CsvClassifier object with updated fields.
Specifies a grok classifier to update when passed to UpdateClassifier.
A GrokClassifier object with updated fields.
Specifies a JSON classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$JsonClassifier' => 'A JsonClassifier object with updated fields.
Specifies an XML classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$XMLClassifier' => 'An XMLClassifier object with updated fields.
The date and time the registry was updated.
', 'GetSchemaResponse$UpdatedTime' => 'The date and time the schema was updated.
', 'RegistryListItem$UpdatedTime' => 'The date the registry was updated.
', 'SchemaListItem$UpdatedTime' => 'The date and time that a schema was updated.
', ], ], 'UpsertRedshiftTargetOptions' => [ 'base' => 'The options to configure an upsert operation when writing to a Redshift target .
', 'refs' => [ 'RedshiftTarget$UpsertRedshiftOptions' => 'The set of options to configure an upsert operation when writing to a Redshift target.
', ], ], 'UriString' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$LogUri' => 'This field is reserved for future use.
', 'DataQualityEvaluationRunAdditionalRunOptions$ResultsS3Prefix' => 'Prefix for Amazon S3 to store results.
', 'ExportLabelsTaskRunProperties$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
', 'ImportLabelsTaskRunProperties$InputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
', 'Job$LogUri' => 'This field is reserved for future use.
', 'JobUpdate$LogUri' => 'This field is reserved for future use.
', 'LabelingSetGenerationTaskRunProperties$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
', 'StartExportLabelsTaskRunRequest$OutputS3Path' => 'The Amazon S3 path where you export the labels.
', 'StartImportLabelsTaskRunRequest$InputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.
', 'StartMLLabelingSetGenerationTaskRunRequest$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.
', ], ], 'UserDefinedFunction' => [ 'base' => 'Represents the equivalent of a Hive user-defined function (UDF) definition.
The requested function definition.
', 'UserDefinedFunctionList$member' => NULL, ], ], 'UserDefinedFunctionInput' => [ 'base' => 'A structure used to create or update a user-defined function.
', 'refs' => [ 'CreateUserDefinedFunctionRequest$FunctionInput' => 'A FunctionInput object that defines the function to create in the Data Catalog.
A FunctionInput object that redefines the function in the Data Catalog.
A list of requested function definitions.
', ], ], 'ValidationException' => [ 'base' => 'A value could not be validated.
', 'refs' => [], ], 'ValueString' => [ 'base' => NULL, 'refs' => [ 'BoundedPartitionValueList$member' => NULL, 'ConnectionProperties$value' => NULL, 'PropertyPredicate$Key' => 'The key of the property.
', 'PropertyPredicate$Value' => 'The value of the property.
', 'SearchTablesRequest$SearchText' => 'A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
', 'SortCriterion$FieldName' => 'The name of the field on which to sort.
', 'ValueStringList$member' => NULL, ], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'DeleteColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', 'DeletePartitionRequest$PartitionValues' => 'The values that define the partition.
', 'GetColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', 'GetPartitionRequest$PartitionValues' => 'The values that define the partition.
', 'GetUnfilteredPartitionMetadataRequest$PartitionValues' => '(Required) A list of partition key values.
', 'Partition$Values' => 'The values of the partition.
', 'PartitionError$PartitionValues' => 'The values that define the partition.
', 'PartitionInput$Values' => 'The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
', 'PartitionValueList$Values' => 'The list of values.
', 'UpdateColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', ], ], 'VersionId' => [ 'base' => NULL, 'refs' => [ 'Crawler$Version' => 'The version of the crawler.
', 'CsvClassifier$Version' => 'The version of this classifier.
', 'GrokClassifier$Version' => 'The version of this classifier.
', 'JsonClassifier$Version' => 'The version of this classifier.
', 'XMLClassifier$Version' => 'The version of this classifier.
', ], ], 'VersionLongNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$LatestSchemaVersion' => 'The latest version of the schema associated with the returned schema definition.
', 'CreateSchemaResponse$NextSchemaVersion' => 'The next version of the schema associated with the returned schema definition.
', 'GetSchemaResponse$LatestSchemaVersion' => 'The latest version of the schema associated with the returned schema definition.
', 'GetSchemaResponse$NextSchemaVersion' => 'The next version of the schema associated with the returned schema definition.
', 'GetSchemaVersionResponse$VersionNumber' => 'The version number of the schema.
', 'PutSchemaVersionMetadataResponse$VersionNumber' => 'The version number of the schema.
', 'RegisterSchemaVersionResponse$VersionNumber' => 'The version of this schema (for sync flow only, in case this is the first version).
', 'RemoveSchemaVersionMetadataResponse$VersionNumber' => 'The version number of the schema.
', 'SchemaReference$SchemaVersionNumber' => 'The version number of the schema.
', 'SchemaVersionErrorItem$VersionNumber' => 'The version number of the schema.
', 'SchemaVersionListItem$VersionNumber' => 'The version number of the schema.
', 'SchemaVersionNumber$VersionNumber' => 'The version number of the schema.
', ], ], 'VersionMismatchException' => [ 'base' => 'There was a version conflict.
', 'refs' => [], ], 'VersionString' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionList$member' => NULL, 'DeleteTableVersionRequest$VersionId' => 'The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.
The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1.
The table version for the Iceberg table. Defaults to 2.
', 'Table$VersionId' => 'The ID of the table version.
', 'TableVersion$VersionId' => 'The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.
The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.
The version ID at which to update the table contents.
', ], ], 'VersionsString' => [ 'base' => NULL, 'refs' => [ 'DeleteSchemaVersionsInput$Versions' => 'A version range may be supplied which may be of the format:
a single version number, 5
a range, 5-8 : deletes versions 5, 6, 7, 8
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'TableInput$ViewOriginalText' => 'Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', ], ], 'WorkerType' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$WorkerType' => 'The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.
', 'CreateJobRequest$WorkerType' => 'The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
A workflow is a collection of multiple dependent Glue jobs and crawlers that are run to complete a complex ETL task. A workflow manages the execution and monitoring of all its jobs and crawlers.
', 'refs' => [ 'GetWorkflowResponse$Workflow' => 'The resource metadata for the workflow.
', 'Workflows$member' => NULL, ], ], 'WorkflowGraph' => [ 'base' => 'A workflow graph represents the complete workflow containing all the Glue components present in the workflow and all the directed connections between them.
', 'refs' => [ 'Workflow$Graph' => 'The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
', 'WorkflowRun$Graph' => 'The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
', ], ], 'WorkflowNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetWorkflowsRequest$Names' => 'A list of workflow names, which may be the names returned from the ListWorkflows operation.
A list of names of workflows not found.
', 'ListWorkflowsResponse$Workflows' => 'List of names of workflows in the account.
', ], ], 'WorkflowRun' => [ 'base' => 'A workflow run is an execution of a workflow providing all the runtime information.
', 'refs' => [ 'GetWorkflowRunResponse$Run' => 'The requested workflow run metadata.
', 'Workflow$LastRun' => 'The information about the last execution of the workflow.
', 'WorkflowRuns$member' => NULL, ], ], 'WorkflowRunProperties' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow.
', 'GetWorkflowRunPropertiesResponse$RunProperties' => 'The workflow run properties which were set during the specified run.
', 'PutWorkflowRunPropertiesRequest$RunProperties' => 'The properties to put for the specified run.
', 'StartWorkflowRunRequest$RunProperties' => 'The workflow run properties for the new workflow run.
', 'UpdateWorkflowRequest$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow.
', 'Workflow$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
', 'WorkflowRun$WorkflowRunProperties' => 'The workflow run properties which were set during the run.
', ], ], 'WorkflowRunStatistics' => [ 'base' => 'Workflow run statistics provides statistics about the workflow run.
', 'refs' => [ 'WorkflowRun$Statistics' => 'The statistics of the run.
', ], ], 'WorkflowRunStatus' => [ 'base' => NULL, 'refs' => [ 'WorkflowRun$Status' => 'The status of the workflow run.
', ], ], 'WorkflowRuns' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowRunsResponse$Runs' => 'A list of workflow run metadata objects.
', ], ], 'Workflows' => [ 'base' => NULL, 'refs' => [ 'BatchGetWorkflowsResponse$Workflows' => 'A list of workflow resource metadata.
', ], ], 'XMLClassifier' => [ 'base' => 'A classifier for XML content.
A classifier for XML content.
', ], ], ],]; diff --git a/src/data/glue/2017-03-31/endpoint-rule-set-1.json b/src/data/glue/2017-03-31/endpoint-rule-set-1.json index 477f7b05b7..d1bd27f670 100644 --- a/src/data/glue/2017-03-31/endpoint-rule-set-1.json +++ b/src/data/glue/2017-03-31/endpoint-rule-set-1.json @@ -58,52 +58,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -111,13 +115,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -127,224 +140,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://glue-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://glue-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://glue-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://glue-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://glue.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://glue.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://glue.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://glue.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } \ No newline at end of file diff --git a/src/data/glue/2017-03-31/endpoint-rule-set-1.json.php b/src/data/glue/2017-03-31/endpoint-rule-set-1.json.php index 914e320d69..cd9735c2da 100644 --- a/src/data/glue/2017-03-31/endpoint-rule-set-1.json.php +++ b/src/data/glue/2017-03-31/endpoint-rule-set-1.json.php @@ -1,3 +1,3 @@ '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://glue-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://glue-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://glue.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://glue.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ], ], ],]; +return [ 'version' => '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://glue-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://glue-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://glue.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://glue.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ],]; diff --git a/src/data/resiliencehub/2020-04-30/api-2.json b/src/data/resiliencehub/2020-04-30/api-2.json index d8185f2c2f..bc6adc78bb 100644 --- a/src/data/resiliencehub/2020-04-30/api-2.json +++ b/src/data/resiliencehub/2020-04-30/api-2.json @@ -30,6 +30,23 @@ {"shape":"AccessDeniedException"} ] }, + "BatchUpdateRecommendationStatus":{ + "name":"BatchUpdateRecommendationStatus", + "http":{ + "method":"POST", + "requestUri":"/batch-update-recommendation-status", + "responseCode":200 + }, + "input":{"shape":"BatchUpdateRecommendationStatusRequest"}, + "output":{"shape":"BatchUpdateRecommendationStatusResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ] + }, "CreateApp":{ "name":"CreateApp", "http":{ @@ -416,6 +433,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} @@ -438,6 +456,22 @@ {"shape":"AccessDeniedException"} ] }, + "ListAppAssessmentComplianceDrifts":{ + "name":"ListAppAssessmentComplianceDrifts", + "http":{ + "method":"POST", + "requestUri":"/list-app-assessment-compliance-drifts", + "responseCode":200 + }, + "input":{"shape":"ListAppAssessmentComplianceDriftsRequest"}, + "output":{"shape":"ListAppAssessmentComplianceDriftsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ] + }, "ListAppAssessments":{ "name":"ListAppAssessments", "http":{ @@ -985,7 +1019,12 @@ "type" ], "members":{ - "appComponentName":{"shape":"EntityId"}, + "appComponentName":{ + "shape":"EntityId", + "deprecated":true, + "deprecatedMessage":"An alarm recommendation can be attached to multiple Application Components, hence this property will be replaced by the new property 'appComponentNames'." + }, + "appComponentNames":{"shape":"AppComponentNameList"}, "description":{"shape":"EntityDescription"}, "items":{"shape":"RecommendationItemList"}, "name":{"shape":"String500"}, @@ -1028,9 +1067,13 @@ "complianceStatus":{"shape":"AppComplianceStatusType"}, "creationTime":{"shape":"TimeStamp"}, "description":{"shape":"EntityDescription"}, + "driftStatus":{"shape":"AppDriftStatusType"}, + "eventSubscriptions":{"shape":"EventSubscriptionList"}, "lastAppComplianceEvaluationTime":{"shape":"TimeStamp"}, + "lastDriftEvaluationTime":{"shape":"TimeStamp"}, "lastResiliencyScoreEvaluationTime":{"shape":"TimeStamp"}, "name":{"shape":"EntityName"}, + "permissionModel":{"shape":"PermissionModel"}, "policyArn":{"shape":"Arn"}, "resiliencyScore":{"shape":"Double"}, "status":{"shape":"AppStatusType"}, @@ -1053,6 +1096,7 @@ "compliance":{"shape":"AssessmentCompliance"}, "complianceStatus":{"shape":"ComplianceStatus"}, "cost":{"shape":"Cost"}, + "driftStatus":{"shape":"DriftStatus"}, "endTime":{"shape":"TimeStamp"}, "invoker":{"shape":"AssessmentInvoker"}, "message":{"shape":"String500"}, @@ -1060,7 +1104,8 @@ "resiliencyScore":{"shape":"ResiliencyScore"}, "resourceErrorsDetails":{"shape":"ResourceErrorsDetails"}, "startTime":{"shape":"TimeStamp"}, - "tags":{"shape":"TagMap"} + "tags":{"shape":"TagMap"}, + "versionName":{"shape":"EntityVersion"} } }, "AppAssessmentScheduleType":{ @@ -1084,11 +1129,13 @@ "assessmentStatus":{"shape":"AssessmentStatus"}, "complianceStatus":{"shape":"ComplianceStatus"}, "cost":{"shape":"Cost"}, + "driftStatus":{"shape":"DriftStatus"}, "endTime":{"shape":"TimeStamp"}, "invoker":{"shape":"AssessmentInvoker"}, "message":{"shape":"String500"}, "resiliencyScore":{"shape":"Double"}, - "startTime":{"shape":"TimeStamp"} + "startTime":{"shape":"TimeStamp"}, + "versionName":{"shape":"EntityVersion"} } }, "AppAssessmentSummaryList":{ @@ -1136,6 +1183,14 @@ "type":"list", "member":{"shape":"String255"} }, + "AppDriftStatusType":{ + "type":"string", + "enum":[ + "NotChecked", + "NotDetected", + "Detected" + ] + }, "AppInputSource":{ "type":"structure", "required":["importType"], @@ -1172,6 +1227,7 @@ "complianceStatus":{"shape":"AppComplianceStatusType"}, "creationTime":{"shape":"TimeStamp"}, "description":{"shape":"EntityDescription"}, + "driftStatus":{"shape":"AppDriftStatusType"}, "name":{"shape":"EntityName"}, "resiliencyScore":{"shape":"Double"}, "status":{"shape":"AppStatusType"} @@ -1195,7 +1251,10 @@ "type":"structure", "required":["appVersion"], "members":{ - "appVersion":{"shape":"EntityVersion"} + "appVersion":{"shape":"EntityVersion"}, + "creationTime":{"shape":"TimeStamp"}, + "identifier":{"shape":"LongOptional"}, + "versionName":{"shape":"EntityVersion"} } }, "Arn":{ @@ -1237,6 +1296,65 @@ "type":"string", "pattern":"^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]$" }, + "BatchUpdateRecommendationStatusFailedEntries":{ + "type":"list", + "member":{"shape":"BatchUpdateRecommendationStatusFailedEntry"} + }, + "BatchUpdateRecommendationStatusFailedEntry":{ + "type":"structure", + "required":[ + "entryId", + "errorMessage" + ], + "members":{ + "entryId":{"shape":"String255"}, + "errorMessage":{"shape":"ErrorMessage"} + } + }, + "BatchUpdateRecommendationStatusRequest":{ + "type":"structure", + "required":[ + "appArn", + "requestEntries" + ], + "members":{ + "appArn":{"shape":"Arn"}, + "requestEntries":{"shape":"UpdateRecommendationStatusRequestEntries"} + } + }, + "BatchUpdateRecommendationStatusResponse":{ + "type":"structure", + "required":[ + "appArn", + "failedEntries", + "successfulEntries" + ], + "members":{ + "appArn":{"shape":"Arn"}, + "failedEntries":{"shape":"BatchUpdateRecommendationStatusFailedEntries"}, + "successfulEntries":{"shape":"BatchUpdateRecommendationStatusSuccessfulEntries"} + } + }, + "BatchUpdateRecommendationStatusSuccessfulEntries":{ + "type":"list", + "member":{"shape":"BatchUpdateRecommendationStatusSuccessfulEntry"} + }, + "BatchUpdateRecommendationStatusSuccessfulEntry":{ + "type":"structure", + "required":[ + "entryId", + "excluded", + "item", + "referenceId" + ], + "members":{ + "entryId":{"shape":"String255"}, + "excludeReason":{"shape":"ExcludeRecommendationReason"}, + "excluded":{"shape":"BooleanOptional"}, + "item":{"shape":"UpdateRecommendationStatusItem"}, + "referenceId":{"shape":"SpecReferenceId"} + } + }, "BooleanOptional":{ "type":"boolean", "box":true @@ -1247,6 +1365,25 @@ "min":1, "pattern":"^[A-za-z0-9_.-]{0,63}$" }, + "ComplianceDrift":{ + "type":"structure", + "members":{ + "actualReferenceId":{"shape":"String255"}, + "actualValue":{"shape":"AssessmentCompliance"}, + "appId":{"shape":"String255"}, + "appVersion":{"shape":"String255"}, + "diffType":{"shape":"DifferenceType"}, + "driftType":{"shape":"DriftType"}, + "entityId":{"shape":"String255"}, + "entityType":{"shape":"String255"}, + "expectedReferenceId":{"shape":"String255"}, + "expectedValue":{"shape":"AssessmentCompliance"} + } + }, + "ComplianceDriftList":{ + "type":"list", + "member":{"shape":"ComplianceDrift"} + }, "ComplianceStatus":{ "type":"string", "enum":[ @@ -1355,7 +1492,9 @@ "idempotencyToken":true }, "description":{"shape":"EntityDescription"}, + "eventSubscriptions":{"shape":"EventSubscriptionList"}, "name":{"shape":"EntityName"}, + "permissionModel":{"shape":"PermissionModel"}, "policyArn":{"shape":"Arn"}, "tags":{"shape":"TagMap"} } @@ -1855,6 +1994,10 @@ "policy":{"shape":"ResiliencyPolicy"} } }, + "DifferenceType":{ + "type":"string", + "enum":["NotEqual"] + }, "DisruptionCompliance":{ "type":"structure", "required":["complianceStatus"], @@ -1896,6 +2039,18 @@ "min":1 }, "Double":{"type":"double"}, + "DriftStatus":{ + "type":"string", + "enum":[ + "NotChecked", + "NotDetected", + "Detected" + ] + }, + "DriftType":{ + "type":"string", + "enum":["ApplicationCompliance"] + }, "EksNamespace":{ "type":"string", "max":63, @@ -1967,6 +2122,39 @@ "L4" ] }, + "EventSubscription":{ + "type":"structure", + "required":[ + "eventType", + "name" + ], + "members":{ + "eventType":{"shape":"EventType"}, + "name":{"shape":"String255"}, + "snsTopicArn":{"shape":"Arn"} + } + }, + "EventSubscriptionList":{ + "type":"list", + "member":{"shape":"EventSubscription"}, + "max":10, + "min":0 + }, + "EventType":{ + "type":"string", + "enum":[ + "ScheduledAssessmentFailure", + "DriftDetected" + ] + }, + "ExcludeRecommendationReason":{ + "type":"string", + "enum":[ + "AlreadyImplemented", + "NotRelevant", + "ComplexityOfImplementation" + ] + }, "FailurePolicy":{ "type":"structure", "required":[ @@ -1988,6 +2176,20 @@ "NoRecoveryPlan" ] }, + "IamRoleArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):iam::[0-9]{12}:role/(([^/][!-~]+/){1,511})?[A-Za-z0-9_+=,.@-]{1,64}$" + }, + "IamRoleArnList":{ + "type":"list", + "member":{"shape":"IamRoleArn"}, + "max":10, + "min":0 + }, + "IamRoleName":{ + "type":"string", + "pattern":"^([^/]([!-~]+/){1,511})?[A-Za-z0-9_+=,.@-]{1,64}$" + }, "ImportResourcesToDraftAppVersionRequest":{ "type":"structure", "required":["appArn"], @@ -2042,6 +2244,23 @@ "nextToken":{"shape":"NextToken"} } }, + "ListAppAssessmentComplianceDriftsRequest":{ + "type":"structure", + "required":["assessmentArn"], + "members":{ + "assessmentArn":{"shape":"Arn"}, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListAppAssessmentComplianceDriftsResponse":{ + "type":"structure", + "required":["complianceDrifts"], + "members":{ + "complianceDrifts":{"shape":"ComplianceDriftList"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListAppAssessmentsRequest":{ "type":"structure", "members":{ @@ -2228,8 +2447,10 @@ "required":["appArn"], "members":{ "appArn":{"shape":"Arn"}, + "endTime":{"shape":"TimeStamp"}, "maxResults":{"shape":"MaxResults"}, - "nextToken":{"shape":"NextToken"} + "nextToken":{"shape":"NextToken"}, + "startTime":{"shape":"TimeStamp"} } }, "ListAppVersionsResponse":{ @@ -2460,6 +2681,10 @@ "terraformSourceName":{"shape":"String255"} } }, + "LongOptional":{ + "type":"long", + "box":true + }, "MaxResults":{ "type":"integer", "box":true, @@ -2470,6 +2695,22 @@ "type":"string", "pattern":"^\\S{1,2000}$" }, + "PermissionModel":{ + "type":"structure", + "required":["type"], + "members":{ + "crossAccountRoleArns":{"shape":"IamRoleArnList"}, + "invokerRoleName":{"shape":"IamRoleName"}, + "type":{"shape":"PermissionModelType"} + } + }, + "PermissionModelType":{ + "type":"string", + "enum":[ + "LegacyIAMUser", + "RoleBased" + ] + }, "PhysicalIdentifierType":{ "type":"string", "enum":[ @@ -2517,7 +2758,8 @@ "type":"structure", "required":["appArn"], "members":{ - "appArn":{"shape":"Arn"} + "appArn":{"shape":"Arn"}, + "versionName":{"shape":"EntityVersion"} } }, "PublishAppVersionResponse":{ @@ -2525,7 +2767,9 @@ "required":["appArn"], "members":{ "appArn":{"shape":"Arn"}, - "appVersion":{"shape":"EntityVersion"} + "appVersion":{"shape":"EntityVersion"}, + "identifier":{"shape":"LongOptional"}, + "versionName":{"shape":"EntityVersion"} } }, "PutDraftAppVersionTemplateRequest":{ @@ -2580,6 +2824,8 @@ "type":"structure", "members":{ "alreadyImplemented":{"shape":"BooleanOptional"}, + "excludeReason":{"shape":"ExcludeRecommendationReason"}, + "excluded":{"shape":"BooleanOptional"}, "resourceId":{"shape":"String500"}, "targetAccountId":{"shape":"CustomerId"}, "targetRegion":{"shape":"AwsRegion"} @@ -2694,7 +2940,8 @@ "Critical", "Important", "CoreServices", - "NonCritical" + "NonCritical", + "NotApplicable" ] }, "ResiliencyScore":{ @@ -3124,6 +3371,8 @@ "assessmentSchedule":{"shape":"AppAssessmentScheduleType"}, "clearResiliencyPolicyArn":{"shape":"BooleanOptional"}, "description":{"shape":"EntityDescription"}, + "eventSubscriptions":{"shape":"EventSubscriptionList"}, + "permissionModel":{"shape":"PermissionModel"}, "policyArn":{"shape":"Arn"} } }, @@ -3208,6 +3457,36 @@ "appVersion":{"shape":"EntityVersion"} } }, + "UpdateRecommendationStatusItem":{ + "type":"structure", + "members":{ + "resourceId":{"shape":"String500"}, + "targetAccountId":{"shape":"CustomerId"}, + "targetRegion":{"shape":"AwsRegion"} + } + }, + "UpdateRecommendationStatusRequestEntries":{ + "type":"list", + "member":{"shape":"UpdateRecommendationStatusRequestEntry"}, + "max":50, + "min":1 + }, + "UpdateRecommendationStatusRequestEntry":{ + "type":"structure", + "required":[ + "entryId", + "excluded", + "item", + "referenceId" + ], + "members":{ + "entryId":{"shape":"String255"}, + "excludeReason":{"shape":"ExcludeRecommendationReason"}, + "excluded":{"shape":"BooleanOptional"}, + "item":{"shape":"UpdateRecommendationStatusItem"}, + "referenceId":{"shape":"SpecReferenceId"} + } + }, "UpdateResiliencyPolicyRequest":{ "type":"structure", "required":["policyArn"], diff --git a/src/data/resiliencehub/2020-04-30/api-2.json.php b/src/data/resiliencehub/2020-04-30/api-2.json.php index a82a79b380..bef56d0f36 100644 --- a/src/data/resiliencehub/2020-04-30/api-2.json.php +++ b/src/data/resiliencehub/2020-04-30/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2020-04-30', 'endpointPrefix' => 'resiliencehub', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'AWS Resilience Hub', 'serviceId' => 'resiliencehub', 'signatureVersion' => 'v4', 'signingName' => 'resiliencehub', 'uid' => 'resiliencehub-2020-04-30', ], 'operations' => [ 'AddDraftAppVersionResourceMappings' => [ 'name' => 'AddDraftAppVersionResourceMappings', 'http' => [ 'method' => 'POST', 'requestUri' => '/add-draft-app-version-resource-mappings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AddDraftAppVersionResourceMappingsRequest', ], 'output' => [ 'shape' => 'AddDraftAppVersionResourceMappingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateApp' => [ 'name' => 'CreateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-app', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAppRequest', ], 'output' => [ 'shape' => 'CreateAppResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateAppVersionAppComponent' => [ 'name' => 'CreateAppVersionAppComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-app-version-app-component', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAppVersionAppComponentRequest', ], 'output' => [ 'shape' => 'CreateAppVersionAppComponentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateAppVersionResource' => [ 'name' => 'CreateAppVersionResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-app-version-resource', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAppVersionResourceRequest', ], 'output' => [ 'shape' => 'CreateAppVersionResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateRecommendationTemplate' => [ 'name' => 'CreateRecommendationTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-recommendation-template', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateRecommendationTemplateRequest', ], 'output' => [ 'shape' => 'CreateRecommendationTemplateResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateResiliencyPolicy' => [ 'name' => 'CreateResiliencyPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-resiliency-policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateResiliencyPolicyRequest', ], 'output' => [ 'shape' => 'CreateResiliencyPolicyResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteApp' => [ 'name' => 'DeleteApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppRequest', ], 'output' => [ 'shape' => 'DeleteAppResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteAppAssessment' => [ 'name' => 'DeleteAppAssessment', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app-assessment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppAssessmentRequest', ], 'output' => [ 'shape' => 'DeleteAppAssessmentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteAppInputSource' => [ 'name' => 'DeleteAppInputSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app-input-source', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppInputSourceRequest', ], 'output' => [ 'shape' => 'DeleteAppInputSourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteAppVersionAppComponent' => [ 'name' => 'DeleteAppVersionAppComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app-version-app-component', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppVersionAppComponentRequest', ], 'output' => [ 'shape' => 'DeleteAppVersionAppComponentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteAppVersionResource' => [ 'name' => 'DeleteAppVersionResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app-version-resource', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppVersionResourceRequest', ], 'output' => [ 'shape' => 'DeleteAppVersionResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteRecommendationTemplate' => [ 'name' => 'DeleteRecommendationTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-recommendation-template', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteRecommendationTemplateRequest', ], 'output' => [ 'shape' => 'DeleteRecommendationTemplateResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteResiliencyPolicy' => [ 'name' => 'DeleteResiliencyPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-resiliency-policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteResiliencyPolicyRequest', ], 'output' => [ 'shape' => 'DeleteResiliencyPolicyResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeApp' => [ 'name' => 'DescribeApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppRequest', ], 'output' => [ 'shape' => 'DescribeAppResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppAssessment' => [ 'name' => 'DescribeAppAssessment', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-assessment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppAssessmentRequest', ], 'output' => [ 'shape' => 'DescribeAppAssessmentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersion' => [ 'name' => 'DescribeAppVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersionAppComponent' => [ 'name' => 'DescribeAppVersionAppComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version-app-component', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionAppComponentRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionAppComponentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersionResource' => [ 'name' => 'DescribeAppVersionResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version-resource', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionResourceRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersionResourcesResolutionStatus' => [ 'name' => 'DescribeAppVersionResourcesResolutionStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version-resources-resolution-status', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionResourcesResolutionStatusRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionResourcesResolutionStatusResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersionTemplate' => [ 'name' => 'DescribeAppVersionTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version-template', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionTemplateRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionTemplateResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeDraftAppVersionResourcesImportStatus' => [ 'name' => 'DescribeDraftAppVersionResourcesImportStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-draft-app-version-resources-import-status', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeDraftAppVersionResourcesImportStatusRequest', ], 'output' => [ 'shape' => 'DescribeDraftAppVersionResourcesImportStatusResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeResiliencyPolicy' => [ 'name' => 'DescribeResiliencyPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-resiliency-policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeResiliencyPolicyRequest', ], 'output' => [ 'shape' => 'DescribeResiliencyPolicyResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ImportResourcesToDraftAppVersion' => [ 'name' => 'ImportResourcesToDraftAppVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/import-resources-to-draft-app-version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ImportResourcesToDraftAppVersionRequest', ], 'output' => [ 'shape' => 'ImportResourcesToDraftAppVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAlarmRecommendations' => [ 'name' => 'ListAlarmRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-alarm-recommendations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAlarmRecommendationsRequest', ], 'output' => [ 'shape' => 'ListAlarmRecommendationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppAssessments' => [ 'name' => 'ListAppAssessments', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-app-assessments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppAssessmentsRequest', ], 'output' => [ 'shape' => 'ListAppAssessmentsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppComponentCompliances' => [ 'name' => 'ListAppComponentCompliances', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-component-compliances', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppComponentCompliancesRequest', ], 'output' => [ 'shape' => 'ListAppComponentCompliancesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppComponentRecommendations' => [ 'name' => 'ListAppComponentRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-component-recommendations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppComponentRecommendationsRequest', ], 'output' => [ 'shape' => 'ListAppComponentRecommendationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppInputSources' => [ 'name' => 'ListAppInputSources', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-input-sources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppInputSourcesRequest', ], 'output' => [ 'shape' => 'ListAppInputSourcesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppVersionAppComponents' => [ 'name' => 'ListAppVersionAppComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-version-app-components', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppVersionAppComponentsRequest', ], 'output' => [ 'shape' => 'ListAppVersionAppComponentsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppVersionResourceMappings' => [ 'name' => 'ListAppVersionResourceMappings', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-version-resource-mappings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppVersionResourceMappingsRequest', ], 'output' => [ 'shape' => 'ListAppVersionResourceMappingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppVersionResources' => [ 'name' => 'ListAppVersionResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-version-resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppVersionResourcesRequest', ], 'output' => [ 'shape' => 'ListAppVersionResourcesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppVersions' => [ 'name' => 'ListAppVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppVersionsRequest', ], 'output' => [ 'shape' => 'ListAppVersionsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListApps' => [ 'name' => 'ListApps', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-apps', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppsRequest', ], 'output' => [ 'shape' => 'ListAppsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListRecommendationTemplates' => [ 'name' => 'ListRecommendationTemplates', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-recommendation-templates', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRecommendationTemplatesRequest', ], 'output' => [ 'shape' => 'ListRecommendationTemplatesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListResiliencyPolicies' => [ 'name' => 'ListResiliencyPolicies', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-resiliency-policies', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListResiliencyPoliciesRequest', ], 'output' => [ 'shape' => 'ListResiliencyPoliciesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListSopRecommendations' => [ 'name' => 'ListSopRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-sop-recommendations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSopRecommendationsRequest', ], 'output' => [ 'shape' => 'ListSopRecommendationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListSuggestedResiliencyPolicies' => [ 'name' => 'ListSuggestedResiliencyPolicies', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-suggested-resiliency-policies', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSuggestedResiliencyPoliciesRequest', ], 'output' => [ 'shape' => 'ListSuggestedResiliencyPoliciesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListTestRecommendations' => [ 'name' => 'ListTestRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-test-recommendations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTestRecommendationsRequest', ], 'output' => [ 'shape' => 'ListTestRecommendationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListUnsupportedAppVersionResources' => [ 'name' => 'ListUnsupportedAppVersionResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-unsupported-app-version-resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListUnsupportedAppVersionResourcesRequest', ], 'output' => [ 'shape' => 'ListUnsupportedAppVersionResourcesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PublishAppVersion' => [ 'name' => 'PublishAppVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/publish-app-version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PublishAppVersionRequest', ], 'output' => [ 'shape' => 'PublishAppVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PutDraftAppVersionTemplate' => [ 'name' => 'PutDraftAppVersionTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/put-draft-app-version-template', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutDraftAppVersionTemplateRequest', ], 'output' => [ 'shape' => 'PutDraftAppVersionTemplateResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'RemoveDraftAppVersionResourceMappings' => [ 'name' => 'RemoveDraftAppVersionResourceMappings', 'http' => [ 'method' => 'POST', 'requestUri' => '/remove-draft-app-version-resource-mappings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'RemoveDraftAppVersionResourceMappingsRequest', ], 'output' => [ 'shape' => 'RemoveDraftAppVersionResourceMappingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ResolveAppVersionResources' => [ 'name' => 'ResolveAppVersionResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/resolve-app-version-resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ResolveAppVersionResourcesRequest', ], 'output' => [ 'shape' => 'ResolveAppVersionResourcesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'StartAppAssessment' => [ 'name' => 'StartAppAssessment', 'http' => [ 'method' => 'POST', 'requestUri' => '/start-app-assessment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartAppAssessmentRequest', ], 'output' => [ 'shape' => 'StartAppAssessmentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateApp' => [ 'name' => 'UpdateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-app', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAppRequest', ], 'output' => [ 'shape' => 'UpdateAppResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateAppVersion' => [ 'name' => 'UpdateAppVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-app-version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAppVersionRequest', ], 'output' => [ 'shape' => 'UpdateAppVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateAppVersionAppComponent' => [ 'name' => 'UpdateAppVersionAppComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-app-version-app-component', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAppVersionAppComponentRequest', ], 'output' => [ 'shape' => 'UpdateAppVersionAppComponentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateAppVersionResource' => [ 'name' => 'UpdateAppVersionResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-app-version-resource', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAppVersionResourceRequest', ], 'output' => [ 'shape' => 'UpdateAppVersionResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateResiliencyPolicy' => [ 'name' => 'UpdateResiliencyPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-resiliency-policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateResiliencyPolicyRequest', ], 'output' => [ 'shape' => 'UpdateResiliencyPolicyResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'AddDraftAppVersionResourceMappingsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'resourceMappings', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'resourceMappings' => [ 'shape' => 'ResourceMappingList', ], ], ], 'AddDraftAppVersionResourceMappingsResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'resourceMappings', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'resourceMappings' => [ 'shape' => 'ResourceMappingList', ], ], ], 'AdditionalInfoMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String128WithoutWhitespace', ], 'value' => [ 'shape' => 'AdditionalInfoValueList', ], ], 'AdditionalInfoValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String1024', ], 'max' => 10, 'min' => 1, ], 'AlarmRecommendation' => [ 'type' => 'structure', 'required' => [ 'name', 'recommendationId', 'referenceId', 'type', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'description' => [ 'shape' => 'EntityDescription', ], 'items' => [ 'shape' => 'RecommendationItemList', ], 'name' => [ 'shape' => 'String500', ], 'prerequisite' => [ 'shape' => 'String500', ], 'recommendationId' => [ 'shape' => 'Uuid', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], 'type' => [ 'shape' => 'AlarmType', ], ], ], 'AlarmRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlarmRecommendation', ], ], 'AlarmReferenceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String500', ], 'max' => 200, 'min' => 1, ], 'AlarmType' => [ 'type' => 'string', 'enum' => [ 'Metric', 'Composite', 'Canary', 'Logs', 'Event', ], ], 'App' => [ 'type' => 'structure', 'required' => [ 'appArn', 'creationTime', 'name', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'assessmentSchedule' => [ 'shape' => 'AppAssessmentScheduleType', ], 'complianceStatus' => [ 'shape' => 'AppComplianceStatusType', ], 'creationTime' => [ 'shape' => 'TimeStamp', ], 'description' => [ 'shape' => 'EntityDescription', ], 'lastAppComplianceEvaluationTime' => [ 'shape' => 'TimeStamp', ], 'lastResiliencyScoreEvaluationTime' => [ 'shape' => 'TimeStamp', ], 'name' => [ 'shape' => 'EntityName', ], 'policyArn' => [ 'shape' => 'Arn', ], 'resiliencyScore' => [ 'shape' => 'Double', ], 'status' => [ 'shape' => 'AppStatusType', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'AppAssessment' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'assessmentStatus', 'invoker', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'assessmentArn' => [ 'shape' => 'Arn', ], 'assessmentName' => [ 'shape' => 'EntityName', ], 'assessmentStatus' => [ 'shape' => 'AssessmentStatus', ], 'compliance' => [ 'shape' => 'AssessmentCompliance', ], 'complianceStatus' => [ 'shape' => 'ComplianceStatus', ], 'cost' => [ 'shape' => 'Cost', ], 'endTime' => [ 'shape' => 'TimeStamp', ], 'invoker' => [ 'shape' => 'AssessmentInvoker', ], 'message' => [ 'shape' => 'String500', ], 'policy' => [ 'shape' => 'ResiliencyPolicy', ], 'resiliencyScore' => [ 'shape' => 'ResiliencyScore', ], 'resourceErrorsDetails' => [ 'shape' => 'ResourceErrorsDetails', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'AppAssessmentScheduleType' => [ 'type' => 'string', 'enum' => [ 'Disabled', 'Daily', ], ], 'AppAssessmentSummary' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'assessmentStatus', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'assessmentArn' => [ 'shape' => 'Arn', ], 'assessmentName' => [ 'shape' => 'EntityName', ], 'assessmentStatus' => [ 'shape' => 'AssessmentStatus', ], 'complianceStatus' => [ 'shape' => 'ComplianceStatus', ], 'cost' => [ 'shape' => 'Cost', ], 'endTime' => [ 'shape' => 'TimeStamp', ], 'invoker' => [ 'shape' => 'AssessmentInvoker', ], 'message' => [ 'shape' => 'String500', ], 'resiliencyScore' => [ 'shape' => 'Double', ], 'startTime' => [ 'shape' => 'TimeStamp', ], ], ], 'AppAssessmentSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppAssessmentSummary', ], ], 'AppComplianceStatusType' => [ 'type' => 'string', 'enum' => [ 'PolicyBreached', 'PolicyMet', 'NotAssessed', 'ChangesDetected', ], ], 'AppComponent' => [ 'type' => 'structure', 'required' => [ 'name', 'type', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'id' => [ 'shape' => 'String255', ], 'name' => [ 'shape' => 'String255', ], 'type' => [ 'shape' => 'String255', ], ], ], 'AppComponentCompliance' => [ 'type' => 'structure', 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'compliance' => [ 'shape' => 'AssessmentCompliance', ], 'cost' => [ 'shape' => 'Cost', ], 'message' => [ 'shape' => 'String500', ], 'resiliencyScore' => [ 'shape' => 'ResiliencyScore', ], 'status' => [ 'shape' => 'ComplianceStatus', ], ], ], 'AppComponentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppComponent', ], ], 'AppComponentNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String255', ], ], 'AppInputSource' => [ 'type' => 'structure', 'required' => [ 'importType', ], 'members' => [ 'eksSourceClusterNamespace' => [ 'shape' => 'EksSourceClusterNamespace', ], 'importType' => [ 'shape' => 'ResourceMappingType', ], 'resourceCount' => [ 'shape' => 'Integer', ], 'sourceArn' => [ 'shape' => 'Arn', ], 'sourceName' => [ 'shape' => 'String255', ], 'terraformSource' => [ 'shape' => 'TerraformSource', ], ], ], 'AppInputSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppInputSource', ], ], 'AppStatusType' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'AppSummary' => [ 'type' => 'structure', 'required' => [ 'appArn', 'creationTime', 'name', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'assessmentSchedule' => [ 'shape' => 'AppAssessmentScheduleType', ], 'complianceStatus' => [ 'shape' => 'AppComplianceStatusType', ], 'creationTime' => [ 'shape' => 'TimeStamp', ], 'description' => [ 'shape' => 'EntityDescription', ], 'name' => [ 'shape' => 'EntityName', ], 'resiliencyScore' => [ 'shape' => 'Double', ], 'status' => [ 'shape' => 'AppStatusType', ], ], ], 'AppSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppSummary', ], ], 'AppTemplateBody' => [ 'type' => 'string', 'max' => 409600, 'min' => 0, 'pattern' => '^[\\w\\s:,-\\.\'\\/{}\\[\\]:"\\\\]+$', ], 'AppVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppVersionSummary', ], ], 'AppVersionSummary' => [ 'type' => 'structure', 'required' => [ 'appVersion', ], 'members' => [ 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'Arn' => [ 'type' => 'string', 'pattern' => '^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$', ], 'ArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], ], 'AssessmentCompliance' => [ 'type' => 'map', 'key' => [ 'shape' => 'DisruptionType', ], 'value' => [ 'shape' => 'DisruptionCompliance', ], ], 'AssessmentInvoker' => [ 'type' => 'string', 'enum' => [ 'User', 'System', ], ], 'AssessmentStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Failed', 'Success', ], ], 'AssessmentStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssessmentStatus', ], 'max' => 10, 'min' => 1, ], 'AwsRegion' => [ 'type' => 'string', 'pattern' => '^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]$', ], 'BooleanOptional' => [ 'type' => 'boolean', 'box' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[A-za-z0-9_.-]{0,63}$', ], 'ComplianceStatus' => [ 'type' => 'string', 'enum' => [ 'PolicyBreached', 'PolicyMet', ], ], 'ComponentCompliancesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppComponentCompliance', ], ], 'ComponentRecommendation' => [ 'type' => 'structure', 'required' => [ 'appComponentName', 'configRecommendations', 'recommendationStatus', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'configRecommendations' => [ 'shape' => 'ConfigRecommendationList', ], 'recommendationStatus' => [ 'shape' => 'RecommendationComplianceStatus', ], ], ], 'ComponentRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComponentRecommendation', ], ], 'ConfigRecommendation' => [ 'type' => 'structure', 'required' => [ 'name', 'optimizationType', 'referenceId', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'compliance' => [ 'shape' => 'AssessmentCompliance', ], 'cost' => [ 'shape' => 'Cost', ], 'description' => [ 'shape' => 'EntityDescription', ], 'haArchitecture' => [ 'shape' => 'HaArchitecture', ], 'name' => [ 'shape' => 'EntityName', ], 'optimizationType' => [ 'shape' => 'ConfigRecommendationOptimizationType', ], 'recommendationCompliance' => [ 'shape' => 'RecommendationCompliance', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], 'suggestedChanges' => [ 'shape' => 'SuggestedChangesList', ], ], ], 'ConfigRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRecommendation', ], ], 'ConfigRecommendationOptimizationType' => [ 'type' => 'string', 'enum' => [ 'LeastCost', 'LeastChange', 'BestAZRecovery', 'LeastErrors', 'BestAttainable', 'BestRegionRecovery', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'Cost' => [ 'type' => 'structure', 'required' => [ 'amount', 'currency', 'frequency', ], 'members' => [ 'amount' => [ 'shape' => 'Double', ], 'currency' => [ 'shape' => 'CurrencyCode', ], 'frequency' => [ 'shape' => 'CostFrequency', ], ], ], 'CostFrequency' => [ 'type' => 'string', 'enum' => [ 'Hourly', 'Daily', 'Monthly', 'Yearly', ], ], 'CreateAppRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'assessmentSchedule' => [ 'shape' => 'AppAssessmentScheduleType', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'EntityDescription', ], 'name' => [ 'shape' => 'EntityName', ], 'policyArn' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateAppResponse' => [ 'type' => 'structure', 'required' => [ 'app', ], 'members' => [ 'app' => [ 'shape' => 'App', ], ], ], 'CreateAppVersionAppComponentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'name', 'type', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'id' => [ 'shape' => 'String255', ], 'name' => [ 'shape' => 'String255', ], 'type' => [ 'shape' => 'String255', ], ], ], 'CreateAppVersionAppComponentResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponent' => [ 'shape' => 'AppComponent', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'CreateAppVersionResourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appComponents', 'logicalResourceId', 'physicalResourceId', 'resourceType', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'appComponents' => [ 'shape' => 'AppComponentNameList', ], 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'String2048', ], 'resourceName' => [ 'shape' => 'EntityName', ], 'resourceType' => [ 'shape' => 'String255', ], ], ], 'CreateAppVersionResourceResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'physicalResource' => [ 'shape' => 'PhysicalResource', ], ], ], 'CreateRecommendationTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'name', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'bucketName' => [ 'shape' => 'EntityName', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'format' => [ 'shape' => 'TemplateFormat', ], 'name' => [ 'shape' => 'EntityName', ], 'recommendationIds' => [ 'shape' => 'RecommendationIdList', ], 'recommendationTypes' => [ 'shape' => 'RenderRecommendationTypeList', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateRecommendationTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'recommendationTemplate' => [ 'shape' => 'RecommendationTemplate', ], ], ], 'CreateResiliencyPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policy', 'policyName', 'tier', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'dataLocationConstraint' => [ 'shape' => 'DataLocationConstraint', ], 'policy' => [ 'shape' => 'DisruptionPolicy', ], 'policyDescription' => [ 'shape' => 'EntityDescription', ], 'policyName' => [ 'shape' => 'EntityName', ], 'tags' => [ 'shape' => 'TagMap', ], 'tier' => [ 'shape' => 'ResiliencyPolicyTier', ], ], ], 'CreateResiliencyPolicyResponse' => [ 'type' => 'structure', 'required' => [ 'policy', ], 'members' => [ 'policy' => [ 'shape' => 'ResiliencyPolicy', ], ], ], 'CurrencyCode' => [ 'type' => 'string', 'max' => 3, 'min' => 0, ], 'CustomerId' => [ 'type' => 'string', 'pattern' => '^[0-9]{12}$', ], 'DataLocationConstraint' => [ 'type' => 'string', 'enum' => [ 'AnyLocation', 'SameContinent', 'SameCountry', ], ], 'DeleteAppAssessmentRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'DeleteAppAssessmentResponse' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'assessmentStatus', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'assessmentStatus' => [ 'shape' => 'AssessmentStatus', ], ], ], 'DeleteAppInputSourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'eksSourceClusterNamespace' => [ 'shape' => 'EksSourceClusterNamespace', ], 'sourceArn' => [ 'shape' => 'Arn', ], 'terraformSource' => [ 'shape' => 'TerraformSource', ], ], ], 'DeleteAppInputSourceResponse' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appInputSource' => [ 'shape' => 'AppInputSource', ], ], ], 'DeleteAppRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'forceDelete' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteAppResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteAppVersionAppComponentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'id', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'id' => [ 'shape' => 'String255', ], ], ], 'DeleteAppVersionAppComponentResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponent' => [ 'shape' => 'AppComponent', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DeleteAppVersionResourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'String2048', ], 'resourceName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteAppVersionResourceResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'physicalResource' => [ 'shape' => 'PhysicalResource', ], ], ], 'DeleteRecommendationTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'recommendationTemplateArn', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'recommendationTemplateArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteRecommendationTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'recommendationTemplateArn', 'status', ], 'members' => [ 'recommendationTemplateArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'RecommendationTemplateStatus', ], ], ], 'DeleteResiliencyPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyArn', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'policyArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteResiliencyPolicyResponse' => [ 'type' => 'structure', 'required' => [ 'policyArn', ], 'members' => [ 'policyArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAppAssessmentRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAppAssessmentResponse' => [ 'type' => 'structure', 'required' => [ 'assessment', ], 'members' => [ 'assessment' => [ 'shape' => 'AppAssessment', ], ], ], 'DescribeAppRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAppResponse' => [ 'type' => 'structure', 'required' => [ 'app', ], 'members' => [ 'app' => [ 'shape' => 'App', ], ], ], 'DescribeAppVersionAppComponentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'id', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'id' => [ 'shape' => 'String255', ], ], ], 'DescribeAppVersionAppComponentResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponent' => [ 'shape' => 'AppComponent', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeAppVersionRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeAppVersionResourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'String2048', ], 'resourceName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeAppVersionResourceResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'physicalResource' => [ 'shape' => 'PhysicalResource', ], ], ], 'DescribeAppVersionResourcesResolutionStatusRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'resolutionId' => [ 'shape' => 'String255', ], ], ], 'DescribeAppVersionResourcesResolutionStatusResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'resolutionId', 'status', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'errorMessage' => [ 'shape' => 'String500', ], 'resolutionId' => [ 'shape' => 'String255', ], 'status' => [ 'shape' => 'ResourceResolutionStatusType', ], ], ], 'DescribeAppVersionResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeAppVersionTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeAppVersionTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appTemplateBody', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appTemplateBody' => [ 'shape' => 'AppTemplateBody', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeDraftAppVersionResourcesImportStatusRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDraftAppVersionResourcesImportStatusResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'status', 'statusChangeTime', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'errorMessage' => [ 'shape' => 'String500', ], 'status' => [ 'shape' => 'ResourceImportStatusType', ], 'statusChangeTime' => [ 'shape' => 'TimeStamp', ], ], ], 'DescribeResiliencyPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyArn', ], 'members' => [ 'policyArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeResiliencyPolicyResponse' => [ 'type' => 'structure', 'required' => [ 'policy', ], 'members' => [ 'policy' => [ 'shape' => 'ResiliencyPolicy', ], ], ], 'DisruptionCompliance' => [ 'type' => 'structure', 'required' => [ 'complianceStatus', ], 'members' => [ 'achievableRpoInSecs' => [ 'shape' => 'Seconds', ], 'achievableRtoInSecs' => [ 'shape' => 'Seconds', ], 'complianceStatus' => [ 'shape' => 'ComplianceStatus', ], 'currentRpoInSecs' => [ 'shape' => 'Seconds', ], 'currentRtoInSecs' => [ 'shape' => 'Seconds', ], 'message' => [ 'shape' => 'String500', ], 'rpoDescription' => [ 'shape' => 'String500', ], 'rpoReferenceId' => [ 'shape' => 'String500', ], 'rtoDescription' => [ 'shape' => 'String500', ], 'rtoReferenceId' => [ 'shape' => 'String500', ], ], ], 'DisruptionPolicy' => [ 'type' => 'map', 'key' => [ 'shape' => 'DisruptionType', ], 'value' => [ 'shape' => 'FailurePolicy', ], ], 'DisruptionResiliencyScore' => [ 'type' => 'map', 'key' => [ 'shape' => 'DisruptionType', ], 'value' => [ 'shape' => 'Double', ], ], 'DisruptionType' => [ 'type' => 'string', 'enum' => [ 'Software', 'Hardware', 'AZ', 'Region', ], ], 'DocumentName' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'Double' => [ 'type' => 'double', ], 'EksNamespace' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$', ], 'EksNamespaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EksNamespace', ], ], 'EksSource' => [ 'type' => 'structure', 'required' => [ 'eksClusterArn', 'namespaces', ], 'members' => [ 'eksClusterArn' => [ 'shape' => 'Arn', ], 'namespaces' => [ 'shape' => 'EksNamespaceList', ], ], ], 'EksSourceClusterNamespace' => [ 'type' => 'structure', 'required' => [ 'eksClusterArn', 'namespace', ], 'members' => [ 'eksClusterArn' => [ 'shape' => 'Arn', ], 'namespace' => [ 'shape' => 'EksNamespace', ], ], ], 'EksSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EksSource', ], ], 'EntityDescription' => [ 'type' => 'string', 'max' => 500, 'min' => 0, ], 'EntityId' => [ 'type' => 'string', 'pattern' => '^\\S{1,255}$', ], 'EntityName' => [ 'type' => 'string', 'pattern' => '^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$', ], 'EntityNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntityName', ], ], 'EntityVersion' => [ 'type' => 'string', 'pattern' => '^\\S{1,50}$', ], 'ErrorMessage' => [ 'type' => 'string', 'max' => 500, 'min' => 0, ], 'EstimatedCostTier' => [ 'type' => 'string', 'enum' => [ 'L1', 'L2', 'L3', 'L4', ], ], 'FailurePolicy' => [ 'type' => 'structure', 'required' => [ 'rpoInSecs', 'rtoInSecs', ], 'members' => [ 'rpoInSecs' => [ 'shape' => 'Seconds', ], 'rtoInSecs' => [ 'shape' => 'Seconds', ], ], ], 'HaArchitecture' => [ 'type' => 'string', 'enum' => [ 'MultiSite', 'WarmStandby', 'PilotLight', 'BackupAndRestore', 'NoRecoveryPlan', ], ], 'ImportResourcesToDraftAppVersionRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'eksSources' => [ 'shape' => 'EksSourceList', ], 'importStrategy' => [ 'shape' => 'ResourceImportStrategyType', ], 'sourceArns' => [ 'shape' => 'ArnList', ], 'terraformSources' => [ 'shape' => 'TerraformSourceList', ], ], ], 'ImportResourcesToDraftAppVersionResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'status', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'eksSources' => [ 'shape' => 'EksSourceList', ], 'sourceArns' => [ 'shape' => 'ArnList', ], 'status' => [ 'shape' => 'ResourceImportStatusType', ], 'terraformSources' => [ 'shape' => 'TerraformSourceList', ], ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'ListAlarmRecommendationsRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAlarmRecommendationsResponse' => [ 'type' => 'structure', 'required' => [ 'alarmRecommendations', ], 'members' => [ 'alarmRecommendations' => [ 'shape' => 'AlarmRecommendationList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppAssessmentsRequest' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'appArn', ], 'assessmentName' => [ 'shape' => 'EntityName', 'location' => 'querystring', 'locationName' => 'assessmentName', ], 'assessmentStatus' => [ 'shape' => 'AssessmentStatusList', 'location' => 'querystring', 'locationName' => 'assessmentStatus', ], 'complianceStatus' => [ 'shape' => 'ComplianceStatus', 'location' => 'querystring', 'locationName' => 'complianceStatus', ], 'invoker' => [ 'shape' => 'AssessmentInvoker', 'location' => 'querystring', 'locationName' => 'invoker', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'reverseOrder' => [ 'shape' => 'BooleanOptional', 'location' => 'querystring', 'locationName' => 'reverseOrder', ], ], ], 'ListAppAssessmentsResponse' => [ 'type' => 'structure', 'required' => [ 'assessmentSummaries', ], 'members' => [ 'assessmentSummaries' => [ 'shape' => 'AppAssessmentSummaryList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppComponentCompliancesRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppComponentCompliancesResponse' => [ 'type' => 'structure', 'required' => [ 'componentCompliances', ], 'members' => [ 'componentCompliances' => [ 'shape' => 'ComponentCompliancesList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppComponentRecommendationsRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppComponentRecommendationsResponse' => [ 'type' => 'structure', 'required' => [ 'componentRecommendations', ], 'members' => [ 'componentRecommendations' => [ 'shape' => 'ComponentRecommendationList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppInputSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppInputSourcesResponse' => [ 'type' => 'structure', 'required' => [ 'appInputSources', ], 'members' => [ 'appInputSources' => [ 'shape' => 'AppInputSourceList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppVersionAppComponentsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppVersionAppComponentsResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponents' => [ 'shape' => 'AppComponentList', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppVersionResourceMappingsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppVersionResourceMappingsResponse' => [ 'type' => 'structure', 'required' => [ 'resourceMappings', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'resourceMappings' => [ 'shape' => 'ResourceMappingList', ], ], ], 'ListAppVersionResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'resolutionId' => [ 'shape' => 'String255', ], ], ], 'ListAppVersionResourcesResponse' => [ 'type' => 'structure', 'required' => [ 'physicalResources', 'resolutionId', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'physicalResources' => [ 'shape' => 'PhysicalResourceList', ], 'resolutionId' => [ 'shape' => 'String255', ], ], ], 'ListAppVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'appVersions', ], 'members' => [ 'appVersions' => [ 'shape' => 'AppVersionList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppsRequest' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'appArn', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'name' => [ 'shape' => 'EntityName', 'location' => 'querystring', 'locationName' => 'name', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListAppsResponse' => [ 'type' => 'structure', 'required' => [ 'appSummaries', ], 'members' => [ 'appSummaries' => [ 'shape' => 'AppSummaryList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRecommendationTemplatesRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'assessmentArn', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'name' => [ 'shape' => 'EntityName', 'location' => 'querystring', 'locationName' => 'name', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'recommendationTemplateArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'recommendationTemplateArn', ], 'reverseOrder' => [ 'shape' => 'BooleanOptional', 'location' => 'querystring', 'locationName' => 'reverseOrder', ], 'status' => [ 'shape' => 'RecommendationTemplateStatusList', 'location' => 'querystring', 'locationName' => 'status', ], ], ], 'ListRecommendationTemplatesResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'recommendationTemplates' => [ 'shape' => 'RecommendationTemplateList', ], ], ], 'ListResiliencyPoliciesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'policyName' => [ 'shape' => 'EntityName', 'location' => 'querystring', 'locationName' => 'policyName', ], ], ], 'ListResiliencyPoliciesResponse' => [ 'type' => 'structure', 'required' => [ 'resiliencyPolicies', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'resiliencyPolicies' => [ 'shape' => 'ResiliencyPolicies', ], ], ], 'ListSopRecommendationsRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSopRecommendationsResponse' => [ 'type' => 'structure', 'required' => [ 'sopRecommendations', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'sopRecommendations' => [ 'shape' => 'SopRecommendationList', ], ], ], 'ListSuggestedResiliencyPoliciesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListSuggestedResiliencyPoliciesResponse' => [ 'type' => 'structure', 'required' => [ 'resiliencyPolicies', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'resiliencyPolicies' => [ 'shape' => 'ResiliencyPolicies', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ListTestRecommendationsRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTestRecommendationsResponse' => [ 'type' => 'structure', 'required' => [ 'testRecommendations', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'testRecommendations' => [ 'shape' => 'TestRecommendationList', ], ], ], 'ListUnsupportedAppVersionResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'resolutionId' => [ 'shape' => 'String255', ], ], ], 'ListUnsupportedAppVersionResourcesResponse' => [ 'type' => 'structure', 'required' => [ 'resolutionId', 'unsupportedResources', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'resolutionId' => [ 'shape' => 'String255', ], 'unsupportedResources' => [ 'shape' => 'UnsupportedResourceList', ], ], ], 'LogicalResourceId' => [ 'type' => 'structure', 'required' => [ 'identifier', ], 'members' => [ 'eksSourceName' => [ 'shape' => 'String255', ], 'identifier' => [ 'shape' => 'String255', ], 'logicalStackName' => [ 'shape' => 'String255', ], 'resourceGroupName' => [ 'shape' => 'EntityName', ], 'terraformSourceName' => [ 'shape' => 'String255', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'NextToken' => [ 'type' => 'string', 'pattern' => '^\\S{1,2000}$', ], 'PhysicalIdentifierType' => [ 'type' => 'string', 'enum' => [ 'Arn', 'Native', ], ], 'PhysicalResource' => [ 'type' => 'structure', 'required' => [ 'logicalResourceId', 'physicalResourceId', 'resourceType', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appComponents' => [ 'shape' => 'AppComponentList', ], 'excluded' => [ 'shape' => 'BooleanOptional', ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'parentResourceName' => [ 'shape' => 'EntityName', ], 'physicalResourceId' => [ 'shape' => 'PhysicalResourceId', ], 'resourceName' => [ 'shape' => 'EntityName', ], 'resourceType' => [ 'shape' => 'String255', ], 'sourceType' => [ 'shape' => 'ResourceSourceType', ], ], ], 'PhysicalResourceId' => [ 'type' => 'structure', 'required' => [ 'identifier', 'type', ], 'members' => [ 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'identifier' => [ 'shape' => 'String255', ], 'type' => [ 'shape' => 'PhysicalIdentifierType', ], ], ], 'PhysicalResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhysicalResource', ], ], 'PublishAppVersionRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], ], ], 'PublishAppVersionResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'PutDraftAppVersionTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appTemplateBody', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appTemplateBody' => [ 'shape' => 'AppTemplateBody', ], ], ], 'PutDraftAppVersionTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'RecommendationCompliance' => [ 'type' => 'map', 'key' => [ 'shape' => 'DisruptionType', ], 'value' => [ 'shape' => 'RecommendationDisruptionCompliance', ], ], 'RecommendationComplianceStatus' => [ 'type' => 'string', 'enum' => [ 'BreachedUnattainable', 'BreachedCanMeet', 'MetCanImprove', ], ], 'RecommendationDisruptionCompliance' => [ 'type' => 'structure', 'required' => [ 'expectedComplianceStatus', ], 'members' => [ 'expectedComplianceStatus' => [ 'shape' => 'ComplianceStatus', ], 'expectedRpoDescription' => [ 'shape' => 'String500', ], 'expectedRpoInSecs' => [ 'shape' => 'Seconds', ], 'expectedRtoDescription' => [ 'shape' => 'String500', ], 'expectedRtoInSecs' => [ 'shape' => 'Seconds', ], ], ], 'RecommendationIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Uuid', ], 'max' => 200, 'min' => 1, ], 'RecommendationItem' => [ 'type' => 'structure', 'members' => [ 'alreadyImplemented' => [ 'shape' => 'BooleanOptional', ], 'resourceId' => [ 'shape' => 'String500', ], 'targetAccountId' => [ 'shape' => 'CustomerId', ], 'targetRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'RecommendationItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationItem', ], ], 'RecommendationTemplate' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'format', 'name', 'recommendationTemplateArn', 'recommendationTypes', 'status', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'assessmentArn' => [ 'shape' => 'Arn', ], 'endTime' => [ 'shape' => 'TimeStamp', ], 'format' => [ 'shape' => 'TemplateFormat', ], 'message' => [ 'shape' => 'String500', ], 'name' => [ 'shape' => 'EntityName', ], 'needsReplacements' => [ 'shape' => 'BooleanOptional', ], 'recommendationIds' => [ 'shape' => 'RecommendationIdList', ], 'recommendationTemplateArn' => [ 'shape' => 'Arn', ], 'recommendationTypes' => [ 'shape' => 'RenderRecommendationTypeList', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'status' => [ 'shape' => 'RecommendationTemplateStatus', ], 'tags' => [ 'shape' => 'TagMap', ], 'templatesLocation' => [ 'shape' => 'S3Location', ], ], ], 'RecommendationTemplateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationTemplate', ], ], 'RecommendationTemplateStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Failed', 'Success', ], ], 'RecommendationTemplateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationTemplateStatus', ], 'max' => 4, 'min' => 1, ], 'RemoveDraftAppVersionResourceMappingsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appRegistryAppNames' => [ 'shape' => 'EntityNameList', ], 'eksSourceNames' => [ 'shape' => 'String255List', ], 'logicalStackNames' => [ 'shape' => 'String255List', ], 'resourceGroupNames' => [ 'shape' => 'EntityNameList', ], 'resourceNames' => [ 'shape' => 'EntityNameList', ], 'terraformSourceNames' => [ 'shape' => 'String255List', ], ], ], 'RemoveDraftAppVersionResourceMappingsResponse' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'RenderRecommendationType' => [ 'type' => 'string', 'enum' => [ 'Alarm', 'Sop', 'Test', ], ], 'RenderRecommendationTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RenderRecommendationType', ], 'max' => 4, 'min' => 1, ], 'ResiliencyPolicies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResiliencyPolicy', ], ], 'ResiliencyPolicy' => [ 'type' => 'structure', 'members' => [ 'creationTime' => [ 'shape' => 'TimeStamp', ], 'dataLocationConstraint' => [ 'shape' => 'DataLocationConstraint', ], 'estimatedCostTier' => [ 'shape' => 'EstimatedCostTier', ], 'policy' => [ 'shape' => 'DisruptionPolicy', ], 'policyArn' => [ 'shape' => 'Arn', ], 'policyDescription' => [ 'shape' => 'EntityDescription', ], 'policyName' => [ 'shape' => 'EntityName', ], 'tags' => [ 'shape' => 'TagMap', ], 'tier' => [ 'shape' => 'ResiliencyPolicyTier', ], ], ], 'ResiliencyPolicyTier' => [ 'type' => 'string', 'enum' => [ 'MissionCritical', 'Critical', 'Important', 'CoreServices', 'NonCritical', ], ], 'ResiliencyScore' => [ 'type' => 'structure', 'required' => [ 'disruptionScore', 'score', ], 'members' => [ 'disruptionScore' => [ 'shape' => 'DisruptionResiliencyScore', ], 'score' => [ 'shape' => 'Double', ], ], ], 'ResolveAppVersionResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'ResolveAppVersionResourcesResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'resolutionId', 'status', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'resolutionId' => [ 'shape' => 'String255', ], 'status' => [ 'shape' => 'ResourceResolutionStatusType', ], ], ], 'ResourceError' => [ 'type' => 'structure', 'members' => [ 'logicalResourceId' => [ 'shape' => 'String255', ], 'physicalResourceId' => [ 'shape' => 'String255', ], 'reason' => [ 'shape' => 'ErrorMessage', ], ], ], 'ResourceErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceError', ], ], 'ResourceErrorsDetails' => [ 'type' => 'structure', 'members' => [ 'hasMoreErrors' => [ 'shape' => 'BooleanOptional', ], 'resourceErrors' => [ 'shape' => 'ResourceErrorList', ], ], ], 'ResourceId' => [ 'type' => 'string', 'pattern' => '.*', ], 'ResourceImportStatusType' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Failed', 'Success', ], ], 'ResourceImportStrategyType' => [ 'type' => 'string', 'enum' => [ 'AddOnly', 'ReplaceAll', ], ], 'ResourceMapping' => [ 'type' => 'structure', 'required' => [ 'mappingType', 'physicalResourceId', ], 'members' => [ 'appRegistryAppName' => [ 'shape' => 'EntityName', ], 'eksSourceName' => [ 'shape' => 'String255', ], 'logicalStackName' => [ 'shape' => 'String255', ], 'mappingType' => [ 'shape' => 'ResourceMappingType', ], 'physicalResourceId' => [ 'shape' => 'PhysicalResourceId', ], 'resourceGroupName' => [ 'shape' => 'EntityName', ], 'resourceName' => [ 'shape' => 'EntityName', ], 'terraformSourceName' => [ 'shape' => 'String255', ], ], ], 'ResourceMappingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceMapping', ], ], 'ResourceMappingType' => [ 'type' => 'string', 'enum' => [ 'CfnStack', 'Resource', 'AppRegistryApp', 'ResourceGroup', 'Terraform', 'EKS', ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourceResolutionStatusType' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Failed', 'Success', ], ], 'ResourceSourceType' => [ 'type' => 'string', 'enum' => [ 'AppTemplate', 'Discovered', ], ], 'ResourceType' => [ 'type' => 'string', 'pattern' => '.*', ], 'RetryAfterSeconds' => [ 'type' => 'integer', 'box' => true, ], 'S3Location' => [ 'type' => 'structure', 'members' => [ 'bucket' => [ 'shape' => 'String500', ], 'prefix' => [ 'shape' => 'String500', ], ], ], 'S3Url' => [ 'type' => 'string', 'max' => 2000, 'min' => 0, 'pattern' => '^((https://([^/]+)\\.s3((-|\\.)[^/]+)?\\.amazonaws\\.com(.cn)?)|(s3://([^/]+)))/\\S{1,2000}$', ], 'Seconds' => [ 'type' => 'integer', 'min' => 0, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'SopRecommendation' => [ 'type' => 'structure', 'required' => [ 'recommendationId', 'referenceId', 'serviceType', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'description' => [ 'shape' => 'String500', ], 'items' => [ 'shape' => 'RecommendationItemList', ], 'name' => [ 'shape' => 'DocumentName', ], 'prerequisite' => [ 'shape' => 'String500', ], 'recommendationId' => [ 'shape' => 'Uuid', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], 'serviceType' => [ 'shape' => 'SopServiceType', ], ], ], 'SopRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SopRecommendation', ], ], 'SopServiceType' => [ 'type' => 'string', 'enum' => [ 'SSM', ], ], 'SpecReferenceId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'StartAppAssessmentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'assessmentName', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'assessmentName' => [ 'shape' => 'EntityName', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'StartAppAssessmentResponse' => [ 'type' => 'structure', 'required' => [ 'assessment', ], 'members' => [ 'assessment' => [ 'shape' => 'AppAssessment', ], ], ], 'String1024' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'String128WithoutWhitespace' => [ 'type' => 'string', 'pattern' => '^\\S{1,128}$', ], 'String2048' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'String255' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'String255List' => [ 'type' => 'list', 'member' => [ 'shape' => 'String255', ], ], 'String500' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'SuggestedChangesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntityDescription', ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^(?!aws:)[^\\x00-\\x1f\\x22]+$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, 'sensitive' => true, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 50, 'min' => 1, 'sensitive' => true, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^[^\\x00-\\x1f\\x22]*$', ], 'TemplateFormat' => [ 'type' => 'string', 'enum' => [ 'CfnYaml', 'CfnJson', ], ], 'TerraformSource' => [ 'type' => 'structure', 'required' => [ 's3StateFileUrl', ], 'members' => [ 's3StateFileUrl' => [ 'shape' => 'S3Url', ], ], ], 'TerraformSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TerraformSource', ], ], 'TestRecommendation' => [ 'type' => 'structure', 'required' => [ 'referenceId', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'dependsOnAlarms' => [ 'shape' => 'AlarmReferenceIdList', ], 'description' => [ 'shape' => 'String500', ], 'intent' => [ 'shape' => 'EntityDescription', ], 'items' => [ 'shape' => 'RecommendationItemList', ], 'name' => [ 'shape' => 'DocumentName', ], 'prerequisite' => [ 'shape' => 'String500', ], 'recommendationId' => [ 'shape' => 'Uuid', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], 'risk' => [ 'shape' => 'TestRisk', ], 'type' => [ 'shape' => 'TestType', ], ], ], 'TestRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TestRecommendation', ], ], 'TestRisk' => [ 'type' => 'string', 'enum' => [ 'Small', 'Medium', 'High', ], ], 'TestType' => [ 'type' => 'string', 'enum' => [ 'Software', 'Hardware', 'AZ', 'Region', ], ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], 'retryAfterSeconds' => [ 'shape' => 'RetryAfterSeconds', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'TimeStamp' => [ 'type' => 'timestamp', ], 'UnsupportedResource' => [ 'type' => 'structure', 'required' => [ 'logicalResourceId', 'physicalResourceId', 'resourceType', ], 'members' => [ 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'PhysicalResourceId', ], 'resourceType' => [ 'shape' => 'String255', ], 'unsupportedResourceStatus' => [ 'shape' => 'String255', ], ], ], 'UnsupportedResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UnsupportedResource', ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAppRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'assessmentSchedule' => [ 'shape' => 'AppAssessmentScheduleType', ], 'clearResiliencyPolicyArn' => [ 'shape' => 'BooleanOptional', ], 'description' => [ 'shape' => 'EntityDescription', ], 'policyArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateAppResponse' => [ 'type' => 'structure', 'required' => [ 'app', ], 'members' => [ 'app' => [ 'shape' => 'App', ], ], ], 'UpdateAppVersionAppComponentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'id', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'id' => [ 'shape' => 'String255', ], 'name' => [ 'shape' => 'String255', ], 'type' => [ 'shape' => 'String255', ], ], ], 'UpdateAppVersionAppComponentResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponent' => [ 'shape' => 'AppComponent', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'UpdateAppVersionRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateAppVersionResourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'appComponents' => [ 'shape' => 'AppComponentNameList', ], 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'excluded' => [ 'shape' => 'BooleanOptional', ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'String2048', ], 'resourceName' => [ 'shape' => 'EntityName', ], 'resourceType' => [ 'shape' => 'String255', ], ], ], 'UpdateAppVersionResourceResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'physicalResource' => [ 'shape' => 'PhysicalResource', ], ], ], 'UpdateAppVersionResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'UpdateResiliencyPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyArn', ], 'members' => [ 'dataLocationConstraint' => [ 'shape' => 'DataLocationConstraint', ], 'policy' => [ 'shape' => 'DisruptionPolicy', ], 'policyArn' => [ 'shape' => 'Arn', ], 'policyDescription' => [ 'shape' => 'EntityDescription', ], 'policyName' => [ 'shape' => 'EntityName', ], 'tier' => [ 'shape' => 'ResiliencyPolicyTier', ], ], ], 'UpdateResiliencyPolicyResponse' => [ 'type' => 'structure', 'required' => [ 'policy', ], 'members' => [ 'policy' => [ 'shape' => 'ResiliencyPolicy', ], ], ], 'Uuid' => [ 'type' => 'string', 'pattern' => '^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$', ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2020-04-30', 'endpointPrefix' => 'resiliencehub', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'AWS Resilience Hub', 'serviceId' => 'resiliencehub', 'signatureVersion' => 'v4', 'signingName' => 'resiliencehub', 'uid' => 'resiliencehub-2020-04-30', ], 'operations' => [ 'AddDraftAppVersionResourceMappings' => [ 'name' => 'AddDraftAppVersionResourceMappings', 'http' => [ 'method' => 'POST', 'requestUri' => '/add-draft-app-version-resource-mappings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AddDraftAppVersionResourceMappingsRequest', ], 'output' => [ 'shape' => 'AddDraftAppVersionResourceMappingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'BatchUpdateRecommendationStatus' => [ 'name' => 'BatchUpdateRecommendationStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/batch-update-recommendation-status', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchUpdateRecommendationStatusRequest', ], 'output' => [ 'shape' => 'BatchUpdateRecommendationStatusResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateApp' => [ 'name' => 'CreateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-app', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAppRequest', ], 'output' => [ 'shape' => 'CreateAppResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateAppVersionAppComponent' => [ 'name' => 'CreateAppVersionAppComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-app-version-app-component', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAppVersionAppComponentRequest', ], 'output' => [ 'shape' => 'CreateAppVersionAppComponentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateAppVersionResource' => [ 'name' => 'CreateAppVersionResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-app-version-resource', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAppVersionResourceRequest', ], 'output' => [ 'shape' => 'CreateAppVersionResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateRecommendationTemplate' => [ 'name' => 'CreateRecommendationTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-recommendation-template', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateRecommendationTemplateRequest', ], 'output' => [ 'shape' => 'CreateRecommendationTemplateResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateResiliencyPolicy' => [ 'name' => 'CreateResiliencyPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-resiliency-policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateResiliencyPolicyRequest', ], 'output' => [ 'shape' => 'CreateResiliencyPolicyResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteApp' => [ 'name' => 'DeleteApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppRequest', ], 'output' => [ 'shape' => 'DeleteAppResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteAppAssessment' => [ 'name' => 'DeleteAppAssessment', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app-assessment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppAssessmentRequest', ], 'output' => [ 'shape' => 'DeleteAppAssessmentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteAppInputSource' => [ 'name' => 'DeleteAppInputSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app-input-source', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppInputSourceRequest', ], 'output' => [ 'shape' => 'DeleteAppInputSourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteAppVersionAppComponent' => [ 'name' => 'DeleteAppVersionAppComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app-version-app-component', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppVersionAppComponentRequest', ], 'output' => [ 'shape' => 'DeleteAppVersionAppComponentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteAppVersionResource' => [ 'name' => 'DeleteAppVersionResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-app-version-resource', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAppVersionResourceRequest', ], 'output' => [ 'shape' => 'DeleteAppVersionResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteRecommendationTemplate' => [ 'name' => 'DeleteRecommendationTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-recommendation-template', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteRecommendationTemplateRequest', ], 'output' => [ 'shape' => 'DeleteRecommendationTemplateResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteResiliencyPolicy' => [ 'name' => 'DeleteResiliencyPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-resiliency-policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteResiliencyPolicyRequest', ], 'output' => [ 'shape' => 'DeleteResiliencyPolicyResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeApp' => [ 'name' => 'DescribeApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppRequest', ], 'output' => [ 'shape' => 'DescribeAppResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppAssessment' => [ 'name' => 'DescribeAppAssessment', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-assessment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppAssessmentRequest', ], 'output' => [ 'shape' => 'DescribeAppAssessmentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersion' => [ 'name' => 'DescribeAppVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersionAppComponent' => [ 'name' => 'DescribeAppVersionAppComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version-app-component', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionAppComponentRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionAppComponentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersionResource' => [ 'name' => 'DescribeAppVersionResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version-resource', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionResourceRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersionResourcesResolutionStatus' => [ 'name' => 'DescribeAppVersionResourcesResolutionStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version-resources-resolution-status', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionResourcesResolutionStatusRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionResourcesResolutionStatusResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeAppVersionTemplate' => [ 'name' => 'DescribeAppVersionTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-app-version-template', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeAppVersionTemplateRequest', ], 'output' => [ 'shape' => 'DescribeAppVersionTemplateResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeDraftAppVersionResourcesImportStatus' => [ 'name' => 'DescribeDraftAppVersionResourcesImportStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-draft-app-version-resources-import-status', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeDraftAppVersionResourcesImportStatusRequest', ], 'output' => [ 'shape' => 'DescribeDraftAppVersionResourcesImportStatusResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeResiliencyPolicy' => [ 'name' => 'DescribeResiliencyPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/describe-resiliency-policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeResiliencyPolicyRequest', ], 'output' => [ 'shape' => 'DescribeResiliencyPolicyResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ImportResourcesToDraftAppVersion' => [ 'name' => 'ImportResourcesToDraftAppVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/import-resources-to-draft-app-version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ImportResourcesToDraftAppVersionRequest', ], 'output' => [ 'shape' => 'ImportResourcesToDraftAppVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAlarmRecommendations' => [ 'name' => 'ListAlarmRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-alarm-recommendations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAlarmRecommendationsRequest', ], 'output' => [ 'shape' => 'ListAlarmRecommendationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppAssessmentComplianceDrifts' => [ 'name' => 'ListAppAssessmentComplianceDrifts', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-assessment-compliance-drifts', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppAssessmentComplianceDriftsRequest', ], 'output' => [ 'shape' => 'ListAppAssessmentComplianceDriftsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppAssessments' => [ 'name' => 'ListAppAssessments', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-app-assessments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppAssessmentsRequest', ], 'output' => [ 'shape' => 'ListAppAssessmentsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppComponentCompliances' => [ 'name' => 'ListAppComponentCompliances', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-component-compliances', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppComponentCompliancesRequest', ], 'output' => [ 'shape' => 'ListAppComponentCompliancesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppComponentRecommendations' => [ 'name' => 'ListAppComponentRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-component-recommendations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppComponentRecommendationsRequest', ], 'output' => [ 'shape' => 'ListAppComponentRecommendationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppInputSources' => [ 'name' => 'ListAppInputSources', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-input-sources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppInputSourcesRequest', ], 'output' => [ 'shape' => 'ListAppInputSourcesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppVersionAppComponents' => [ 'name' => 'ListAppVersionAppComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-version-app-components', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppVersionAppComponentsRequest', ], 'output' => [ 'shape' => 'ListAppVersionAppComponentsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppVersionResourceMappings' => [ 'name' => 'ListAppVersionResourceMappings', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-version-resource-mappings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppVersionResourceMappingsRequest', ], 'output' => [ 'shape' => 'ListAppVersionResourceMappingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppVersionResources' => [ 'name' => 'ListAppVersionResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-version-resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppVersionResourcesRequest', ], 'output' => [ 'shape' => 'ListAppVersionResourcesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAppVersions' => [ 'name' => 'ListAppVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-app-versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppVersionsRequest', ], 'output' => [ 'shape' => 'ListAppVersionsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListApps' => [ 'name' => 'ListApps', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-apps', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAppsRequest', ], 'output' => [ 'shape' => 'ListAppsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListRecommendationTemplates' => [ 'name' => 'ListRecommendationTemplates', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-recommendation-templates', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRecommendationTemplatesRequest', ], 'output' => [ 'shape' => 'ListRecommendationTemplatesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListResiliencyPolicies' => [ 'name' => 'ListResiliencyPolicies', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-resiliency-policies', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListResiliencyPoliciesRequest', ], 'output' => [ 'shape' => 'ListResiliencyPoliciesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListSopRecommendations' => [ 'name' => 'ListSopRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-sop-recommendations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSopRecommendationsRequest', ], 'output' => [ 'shape' => 'ListSopRecommendationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListSuggestedResiliencyPolicies' => [ 'name' => 'ListSuggestedResiliencyPolicies', 'http' => [ 'method' => 'GET', 'requestUri' => '/list-suggested-resiliency-policies', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSuggestedResiliencyPoliciesRequest', ], 'output' => [ 'shape' => 'ListSuggestedResiliencyPoliciesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListTestRecommendations' => [ 'name' => 'ListTestRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-test-recommendations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTestRecommendationsRequest', ], 'output' => [ 'shape' => 'ListTestRecommendationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListUnsupportedAppVersionResources' => [ 'name' => 'ListUnsupportedAppVersionResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-unsupported-app-version-resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListUnsupportedAppVersionResourcesRequest', ], 'output' => [ 'shape' => 'ListUnsupportedAppVersionResourcesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PublishAppVersion' => [ 'name' => 'PublishAppVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/publish-app-version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PublishAppVersionRequest', ], 'output' => [ 'shape' => 'PublishAppVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PutDraftAppVersionTemplate' => [ 'name' => 'PutDraftAppVersionTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/put-draft-app-version-template', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutDraftAppVersionTemplateRequest', ], 'output' => [ 'shape' => 'PutDraftAppVersionTemplateResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'RemoveDraftAppVersionResourceMappings' => [ 'name' => 'RemoveDraftAppVersionResourceMappings', 'http' => [ 'method' => 'POST', 'requestUri' => '/remove-draft-app-version-resource-mappings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'RemoveDraftAppVersionResourceMappingsRequest', ], 'output' => [ 'shape' => 'RemoveDraftAppVersionResourceMappingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ResolveAppVersionResources' => [ 'name' => 'ResolveAppVersionResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/resolve-app-version-resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ResolveAppVersionResourcesRequest', ], 'output' => [ 'shape' => 'ResolveAppVersionResourcesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'StartAppAssessment' => [ 'name' => 'StartAppAssessment', 'http' => [ 'method' => 'POST', 'requestUri' => '/start-app-assessment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartAppAssessmentRequest', ], 'output' => [ 'shape' => 'StartAppAssessmentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateApp' => [ 'name' => 'UpdateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-app', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAppRequest', ], 'output' => [ 'shape' => 'UpdateAppResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateAppVersion' => [ 'name' => 'UpdateAppVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-app-version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAppVersionRequest', ], 'output' => [ 'shape' => 'UpdateAppVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateAppVersionAppComponent' => [ 'name' => 'UpdateAppVersionAppComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-app-version-app-component', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAppVersionAppComponentRequest', ], 'output' => [ 'shape' => 'UpdateAppVersionAppComponentResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateAppVersionResource' => [ 'name' => 'UpdateAppVersionResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-app-version-resource', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAppVersionResourceRequest', ], 'output' => [ 'shape' => 'UpdateAppVersionResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateResiliencyPolicy' => [ 'name' => 'UpdateResiliencyPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-resiliency-policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateResiliencyPolicyRequest', ], 'output' => [ 'shape' => 'UpdateResiliencyPolicyResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'AddDraftAppVersionResourceMappingsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'resourceMappings', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'resourceMappings' => [ 'shape' => 'ResourceMappingList', ], ], ], 'AddDraftAppVersionResourceMappingsResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'resourceMappings', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'resourceMappings' => [ 'shape' => 'ResourceMappingList', ], ], ], 'AdditionalInfoMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String128WithoutWhitespace', ], 'value' => [ 'shape' => 'AdditionalInfoValueList', ], ], 'AdditionalInfoValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String1024', ], 'max' => 10, 'min' => 1, ], 'AlarmRecommendation' => [ 'type' => 'structure', 'required' => [ 'name', 'recommendationId', 'referenceId', 'type', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', 'deprecated' => true, 'deprecatedMessage' => 'An alarm recommendation can be attached to multiple Application Components, hence this property will be replaced by the new property \'appComponentNames\'.', ], 'appComponentNames' => [ 'shape' => 'AppComponentNameList', ], 'description' => [ 'shape' => 'EntityDescription', ], 'items' => [ 'shape' => 'RecommendationItemList', ], 'name' => [ 'shape' => 'String500', ], 'prerequisite' => [ 'shape' => 'String500', ], 'recommendationId' => [ 'shape' => 'Uuid', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], 'type' => [ 'shape' => 'AlarmType', ], ], ], 'AlarmRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlarmRecommendation', ], ], 'AlarmReferenceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String500', ], 'max' => 200, 'min' => 1, ], 'AlarmType' => [ 'type' => 'string', 'enum' => [ 'Metric', 'Composite', 'Canary', 'Logs', 'Event', ], ], 'App' => [ 'type' => 'structure', 'required' => [ 'appArn', 'creationTime', 'name', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'assessmentSchedule' => [ 'shape' => 'AppAssessmentScheduleType', ], 'complianceStatus' => [ 'shape' => 'AppComplianceStatusType', ], 'creationTime' => [ 'shape' => 'TimeStamp', ], 'description' => [ 'shape' => 'EntityDescription', ], 'driftStatus' => [ 'shape' => 'AppDriftStatusType', ], 'eventSubscriptions' => [ 'shape' => 'EventSubscriptionList', ], 'lastAppComplianceEvaluationTime' => [ 'shape' => 'TimeStamp', ], 'lastDriftEvaluationTime' => [ 'shape' => 'TimeStamp', ], 'lastResiliencyScoreEvaluationTime' => [ 'shape' => 'TimeStamp', ], 'name' => [ 'shape' => 'EntityName', ], 'permissionModel' => [ 'shape' => 'PermissionModel', ], 'policyArn' => [ 'shape' => 'Arn', ], 'resiliencyScore' => [ 'shape' => 'Double', ], 'status' => [ 'shape' => 'AppStatusType', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'AppAssessment' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'assessmentStatus', 'invoker', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'assessmentArn' => [ 'shape' => 'Arn', ], 'assessmentName' => [ 'shape' => 'EntityName', ], 'assessmentStatus' => [ 'shape' => 'AssessmentStatus', ], 'compliance' => [ 'shape' => 'AssessmentCompliance', ], 'complianceStatus' => [ 'shape' => 'ComplianceStatus', ], 'cost' => [ 'shape' => 'Cost', ], 'driftStatus' => [ 'shape' => 'DriftStatus', ], 'endTime' => [ 'shape' => 'TimeStamp', ], 'invoker' => [ 'shape' => 'AssessmentInvoker', ], 'message' => [ 'shape' => 'String500', ], 'policy' => [ 'shape' => 'ResiliencyPolicy', ], 'resiliencyScore' => [ 'shape' => 'ResiliencyScore', ], 'resourceErrorsDetails' => [ 'shape' => 'ResourceErrorsDetails', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'tags' => [ 'shape' => 'TagMap', ], 'versionName' => [ 'shape' => 'EntityVersion', ], ], ], 'AppAssessmentScheduleType' => [ 'type' => 'string', 'enum' => [ 'Disabled', 'Daily', ], ], 'AppAssessmentSummary' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'assessmentStatus', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'assessmentArn' => [ 'shape' => 'Arn', ], 'assessmentName' => [ 'shape' => 'EntityName', ], 'assessmentStatus' => [ 'shape' => 'AssessmentStatus', ], 'complianceStatus' => [ 'shape' => 'ComplianceStatus', ], 'cost' => [ 'shape' => 'Cost', ], 'driftStatus' => [ 'shape' => 'DriftStatus', ], 'endTime' => [ 'shape' => 'TimeStamp', ], 'invoker' => [ 'shape' => 'AssessmentInvoker', ], 'message' => [ 'shape' => 'String500', ], 'resiliencyScore' => [ 'shape' => 'Double', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'versionName' => [ 'shape' => 'EntityVersion', ], ], ], 'AppAssessmentSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppAssessmentSummary', ], ], 'AppComplianceStatusType' => [ 'type' => 'string', 'enum' => [ 'PolicyBreached', 'PolicyMet', 'NotAssessed', 'ChangesDetected', ], ], 'AppComponent' => [ 'type' => 'structure', 'required' => [ 'name', 'type', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'id' => [ 'shape' => 'String255', ], 'name' => [ 'shape' => 'String255', ], 'type' => [ 'shape' => 'String255', ], ], ], 'AppComponentCompliance' => [ 'type' => 'structure', 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'compliance' => [ 'shape' => 'AssessmentCompliance', ], 'cost' => [ 'shape' => 'Cost', ], 'message' => [ 'shape' => 'String500', ], 'resiliencyScore' => [ 'shape' => 'ResiliencyScore', ], 'status' => [ 'shape' => 'ComplianceStatus', ], ], ], 'AppComponentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppComponent', ], ], 'AppComponentNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String255', ], ], 'AppDriftStatusType' => [ 'type' => 'string', 'enum' => [ 'NotChecked', 'NotDetected', 'Detected', ], ], 'AppInputSource' => [ 'type' => 'structure', 'required' => [ 'importType', ], 'members' => [ 'eksSourceClusterNamespace' => [ 'shape' => 'EksSourceClusterNamespace', ], 'importType' => [ 'shape' => 'ResourceMappingType', ], 'resourceCount' => [ 'shape' => 'Integer', ], 'sourceArn' => [ 'shape' => 'Arn', ], 'sourceName' => [ 'shape' => 'String255', ], 'terraformSource' => [ 'shape' => 'TerraformSource', ], ], ], 'AppInputSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppInputSource', ], ], 'AppStatusType' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'AppSummary' => [ 'type' => 'structure', 'required' => [ 'appArn', 'creationTime', 'name', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'assessmentSchedule' => [ 'shape' => 'AppAssessmentScheduleType', ], 'complianceStatus' => [ 'shape' => 'AppComplianceStatusType', ], 'creationTime' => [ 'shape' => 'TimeStamp', ], 'description' => [ 'shape' => 'EntityDescription', ], 'driftStatus' => [ 'shape' => 'AppDriftStatusType', ], 'name' => [ 'shape' => 'EntityName', ], 'resiliencyScore' => [ 'shape' => 'Double', ], 'status' => [ 'shape' => 'AppStatusType', ], ], ], 'AppSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppSummary', ], ], 'AppTemplateBody' => [ 'type' => 'string', 'max' => 409600, 'min' => 0, 'pattern' => '^[\\w\\s:,-\\.\'\\/{}\\[\\]:"\\\\]+$', ], 'AppVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppVersionSummary', ], ], 'AppVersionSummary' => [ 'type' => 'structure', 'required' => [ 'appVersion', ], 'members' => [ 'appVersion' => [ 'shape' => 'EntityVersion', ], 'creationTime' => [ 'shape' => 'TimeStamp', ], 'identifier' => [ 'shape' => 'LongOptional', ], 'versionName' => [ 'shape' => 'EntityVersion', ], ], ], 'Arn' => [ 'type' => 'string', 'pattern' => '^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$', ], 'ArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], ], 'AssessmentCompliance' => [ 'type' => 'map', 'key' => [ 'shape' => 'DisruptionType', ], 'value' => [ 'shape' => 'DisruptionCompliance', ], ], 'AssessmentInvoker' => [ 'type' => 'string', 'enum' => [ 'User', 'System', ], ], 'AssessmentStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Failed', 'Success', ], ], 'AssessmentStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssessmentStatus', ], 'max' => 10, 'min' => 1, ], 'AwsRegion' => [ 'type' => 'string', 'pattern' => '^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]$', ], 'BatchUpdateRecommendationStatusFailedEntries' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchUpdateRecommendationStatusFailedEntry', ], ], 'BatchUpdateRecommendationStatusFailedEntry' => [ 'type' => 'structure', 'required' => [ 'entryId', 'errorMessage', ], 'members' => [ 'entryId' => [ 'shape' => 'String255', ], 'errorMessage' => [ 'shape' => 'ErrorMessage', ], ], ], 'BatchUpdateRecommendationStatusRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'requestEntries', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'requestEntries' => [ 'shape' => 'UpdateRecommendationStatusRequestEntries', ], ], ], 'BatchUpdateRecommendationStatusResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'failedEntries', 'successfulEntries', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'failedEntries' => [ 'shape' => 'BatchUpdateRecommendationStatusFailedEntries', ], 'successfulEntries' => [ 'shape' => 'BatchUpdateRecommendationStatusSuccessfulEntries', ], ], ], 'BatchUpdateRecommendationStatusSuccessfulEntries' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchUpdateRecommendationStatusSuccessfulEntry', ], ], 'BatchUpdateRecommendationStatusSuccessfulEntry' => [ 'type' => 'structure', 'required' => [ 'entryId', 'excluded', 'item', 'referenceId', ], 'members' => [ 'entryId' => [ 'shape' => 'String255', ], 'excludeReason' => [ 'shape' => 'ExcludeRecommendationReason', ], 'excluded' => [ 'shape' => 'BooleanOptional', ], 'item' => [ 'shape' => 'UpdateRecommendationStatusItem', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], ], ], 'BooleanOptional' => [ 'type' => 'boolean', 'box' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[A-za-z0-9_.-]{0,63}$', ], 'ComplianceDrift' => [ 'type' => 'structure', 'members' => [ 'actualReferenceId' => [ 'shape' => 'String255', ], 'actualValue' => [ 'shape' => 'AssessmentCompliance', ], 'appId' => [ 'shape' => 'String255', ], 'appVersion' => [ 'shape' => 'String255', ], 'diffType' => [ 'shape' => 'DifferenceType', ], 'driftType' => [ 'shape' => 'DriftType', ], 'entityId' => [ 'shape' => 'String255', ], 'entityType' => [ 'shape' => 'String255', ], 'expectedReferenceId' => [ 'shape' => 'String255', ], 'expectedValue' => [ 'shape' => 'AssessmentCompliance', ], ], ], 'ComplianceDriftList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceDrift', ], ], 'ComplianceStatus' => [ 'type' => 'string', 'enum' => [ 'PolicyBreached', 'PolicyMet', ], ], 'ComponentCompliancesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppComponentCompliance', ], ], 'ComponentRecommendation' => [ 'type' => 'structure', 'required' => [ 'appComponentName', 'configRecommendations', 'recommendationStatus', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'configRecommendations' => [ 'shape' => 'ConfigRecommendationList', ], 'recommendationStatus' => [ 'shape' => 'RecommendationComplianceStatus', ], ], ], 'ComponentRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComponentRecommendation', ], ], 'ConfigRecommendation' => [ 'type' => 'structure', 'required' => [ 'name', 'optimizationType', 'referenceId', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'compliance' => [ 'shape' => 'AssessmentCompliance', ], 'cost' => [ 'shape' => 'Cost', ], 'description' => [ 'shape' => 'EntityDescription', ], 'haArchitecture' => [ 'shape' => 'HaArchitecture', ], 'name' => [ 'shape' => 'EntityName', ], 'optimizationType' => [ 'shape' => 'ConfigRecommendationOptimizationType', ], 'recommendationCompliance' => [ 'shape' => 'RecommendationCompliance', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], 'suggestedChanges' => [ 'shape' => 'SuggestedChangesList', ], ], ], 'ConfigRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRecommendation', ], ], 'ConfigRecommendationOptimizationType' => [ 'type' => 'string', 'enum' => [ 'LeastCost', 'LeastChange', 'BestAZRecovery', 'LeastErrors', 'BestAttainable', 'BestRegionRecovery', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'Cost' => [ 'type' => 'structure', 'required' => [ 'amount', 'currency', 'frequency', ], 'members' => [ 'amount' => [ 'shape' => 'Double', ], 'currency' => [ 'shape' => 'CurrencyCode', ], 'frequency' => [ 'shape' => 'CostFrequency', ], ], ], 'CostFrequency' => [ 'type' => 'string', 'enum' => [ 'Hourly', 'Daily', 'Monthly', 'Yearly', ], ], 'CreateAppRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'assessmentSchedule' => [ 'shape' => 'AppAssessmentScheduleType', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'EntityDescription', ], 'eventSubscriptions' => [ 'shape' => 'EventSubscriptionList', ], 'name' => [ 'shape' => 'EntityName', ], 'permissionModel' => [ 'shape' => 'PermissionModel', ], 'policyArn' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateAppResponse' => [ 'type' => 'structure', 'required' => [ 'app', ], 'members' => [ 'app' => [ 'shape' => 'App', ], ], ], 'CreateAppVersionAppComponentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'name', 'type', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'id' => [ 'shape' => 'String255', ], 'name' => [ 'shape' => 'String255', ], 'type' => [ 'shape' => 'String255', ], ], ], 'CreateAppVersionAppComponentResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponent' => [ 'shape' => 'AppComponent', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'CreateAppVersionResourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appComponents', 'logicalResourceId', 'physicalResourceId', 'resourceType', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'appComponents' => [ 'shape' => 'AppComponentNameList', ], 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'String2048', ], 'resourceName' => [ 'shape' => 'EntityName', ], 'resourceType' => [ 'shape' => 'String255', ], ], ], 'CreateAppVersionResourceResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'physicalResource' => [ 'shape' => 'PhysicalResource', ], ], ], 'CreateRecommendationTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'name', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'bucketName' => [ 'shape' => 'EntityName', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'format' => [ 'shape' => 'TemplateFormat', ], 'name' => [ 'shape' => 'EntityName', ], 'recommendationIds' => [ 'shape' => 'RecommendationIdList', ], 'recommendationTypes' => [ 'shape' => 'RenderRecommendationTypeList', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateRecommendationTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'recommendationTemplate' => [ 'shape' => 'RecommendationTemplate', ], ], ], 'CreateResiliencyPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policy', 'policyName', 'tier', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'dataLocationConstraint' => [ 'shape' => 'DataLocationConstraint', ], 'policy' => [ 'shape' => 'DisruptionPolicy', ], 'policyDescription' => [ 'shape' => 'EntityDescription', ], 'policyName' => [ 'shape' => 'EntityName', ], 'tags' => [ 'shape' => 'TagMap', ], 'tier' => [ 'shape' => 'ResiliencyPolicyTier', ], ], ], 'CreateResiliencyPolicyResponse' => [ 'type' => 'structure', 'required' => [ 'policy', ], 'members' => [ 'policy' => [ 'shape' => 'ResiliencyPolicy', ], ], ], 'CurrencyCode' => [ 'type' => 'string', 'max' => 3, 'min' => 0, ], 'CustomerId' => [ 'type' => 'string', 'pattern' => '^[0-9]{12}$', ], 'DataLocationConstraint' => [ 'type' => 'string', 'enum' => [ 'AnyLocation', 'SameContinent', 'SameCountry', ], ], 'DeleteAppAssessmentRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'DeleteAppAssessmentResponse' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'assessmentStatus', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'assessmentStatus' => [ 'shape' => 'AssessmentStatus', ], ], ], 'DeleteAppInputSourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'eksSourceClusterNamespace' => [ 'shape' => 'EksSourceClusterNamespace', ], 'sourceArn' => [ 'shape' => 'Arn', ], 'terraformSource' => [ 'shape' => 'TerraformSource', ], ], ], 'DeleteAppInputSourceResponse' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appInputSource' => [ 'shape' => 'AppInputSource', ], ], ], 'DeleteAppRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'forceDelete' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteAppResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteAppVersionAppComponentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'id', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'id' => [ 'shape' => 'String255', ], ], ], 'DeleteAppVersionAppComponentResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponent' => [ 'shape' => 'AppComponent', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DeleteAppVersionResourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'String2048', ], 'resourceName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteAppVersionResourceResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'physicalResource' => [ 'shape' => 'PhysicalResource', ], ], ], 'DeleteRecommendationTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'recommendationTemplateArn', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'recommendationTemplateArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteRecommendationTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'recommendationTemplateArn', 'status', ], 'members' => [ 'recommendationTemplateArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'RecommendationTemplateStatus', ], ], ], 'DeleteResiliencyPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyArn', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'policyArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteResiliencyPolicyResponse' => [ 'type' => 'structure', 'required' => [ 'policyArn', ], 'members' => [ 'policyArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAppAssessmentRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAppAssessmentResponse' => [ 'type' => 'structure', 'required' => [ 'assessment', ], 'members' => [ 'assessment' => [ 'shape' => 'AppAssessment', ], ], ], 'DescribeAppRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAppResponse' => [ 'type' => 'structure', 'required' => [ 'app', ], 'members' => [ 'app' => [ 'shape' => 'App', ], ], ], 'DescribeAppVersionAppComponentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'id', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'id' => [ 'shape' => 'String255', ], ], ], 'DescribeAppVersionAppComponentResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponent' => [ 'shape' => 'AppComponent', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeAppVersionRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeAppVersionResourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'String2048', ], 'resourceName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeAppVersionResourceResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'physicalResource' => [ 'shape' => 'PhysicalResource', ], ], ], 'DescribeAppVersionResourcesResolutionStatusRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'resolutionId' => [ 'shape' => 'String255', ], ], ], 'DescribeAppVersionResourcesResolutionStatusResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'resolutionId', 'status', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'errorMessage' => [ 'shape' => 'String500', ], 'resolutionId' => [ 'shape' => 'String255', ], 'status' => [ 'shape' => 'ResourceResolutionStatusType', ], ], ], 'DescribeAppVersionResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeAppVersionTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeAppVersionTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appTemplateBody', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appTemplateBody' => [ 'shape' => 'AppTemplateBody', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'DescribeDraftAppVersionResourcesImportStatusRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDraftAppVersionResourcesImportStatusResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'status', 'statusChangeTime', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'errorMessage' => [ 'shape' => 'String500', ], 'status' => [ 'shape' => 'ResourceImportStatusType', ], 'statusChangeTime' => [ 'shape' => 'TimeStamp', ], ], ], 'DescribeResiliencyPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyArn', ], 'members' => [ 'policyArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeResiliencyPolicyResponse' => [ 'type' => 'structure', 'required' => [ 'policy', ], 'members' => [ 'policy' => [ 'shape' => 'ResiliencyPolicy', ], ], ], 'DifferenceType' => [ 'type' => 'string', 'enum' => [ 'NotEqual', ], ], 'DisruptionCompliance' => [ 'type' => 'structure', 'required' => [ 'complianceStatus', ], 'members' => [ 'achievableRpoInSecs' => [ 'shape' => 'Seconds', ], 'achievableRtoInSecs' => [ 'shape' => 'Seconds', ], 'complianceStatus' => [ 'shape' => 'ComplianceStatus', ], 'currentRpoInSecs' => [ 'shape' => 'Seconds', ], 'currentRtoInSecs' => [ 'shape' => 'Seconds', ], 'message' => [ 'shape' => 'String500', ], 'rpoDescription' => [ 'shape' => 'String500', ], 'rpoReferenceId' => [ 'shape' => 'String500', ], 'rtoDescription' => [ 'shape' => 'String500', ], 'rtoReferenceId' => [ 'shape' => 'String500', ], ], ], 'DisruptionPolicy' => [ 'type' => 'map', 'key' => [ 'shape' => 'DisruptionType', ], 'value' => [ 'shape' => 'FailurePolicy', ], ], 'DisruptionResiliencyScore' => [ 'type' => 'map', 'key' => [ 'shape' => 'DisruptionType', ], 'value' => [ 'shape' => 'Double', ], ], 'DisruptionType' => [ 'type' => 'string', 'enum' => [ 'Software', 'Hardware', 'AZ', 'Region', ], ], 'DocumentName' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'Double' => [ 'type' => 'double', ], 'DriftStatus' => [ 'type' => 'string', 'enum' => [ 'NotChecked', 'NotDetected', 'Detected', ], ], 'DriftType' => [ 'type' => 'string', 'enum' => [ 'ApplicationCompliance', ], ], 'EksNamespace' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$', ], 'EksNamespaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EksNamespace', ], ], 'EksSource' => [ 'type' => 'structure', 'required' => [ 'eksClusterArn', 'namespaces', ], 'members' => [ 'eksClusterArn' => [ 'shape' => 'Arn', ], 'namespaces' => [ 'shape' => 'EksNamespaceList', ], ], ], 'EksSourceClusterNamespace' => [ 'type' => 'structure', 'required' => [ 'eksClusterArn', 'namespace', ], 'members' => [ 'eksClusterArn' => [ 'shape' => 'Arn', ], 'namespace' => [ 'shape' => 'EksNamespace', ], ], ], 'EksSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EksSource', ], ], 'EntityDescription' => [ 'type' => 'string', 'max' => 500, 'min' => 0, ], 'EntityId' => [ 'type' => 'string', 'pattern' => '^\\S{1,255}$', ], 'EntityName' => [ 'type' => 'string', 'pattern' => '^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$', ], 'EntityNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntityName', ], ], 'EntityVersion' => [ 'type' => 'string', 'pattern' => '^\\S{1,50}$', ], 'ErrorMessage' => [ 'type' => 'string', 'max' => 500, 'min' => 0, ], 'EstimatedCostTier' => [ 'type' => 'string', 'enum' => [ 'L1', 'L2', 'L3', 'L4', ], ], 'EventSubscription' => [ 'type' => 'structure', 'required' => [ 'eventType', 'name', ], 'members' => [ 'eventType' => [ 'shape' => 'EventType', ], 'name' => [ 'shape' => 'String255', ], 'snsTopicArn' => [ 'shape' => 'Arn', ], ], ], 'EventSubscriptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventSubscription', ], 'max' => 10, 'min' => 0, ], 'EventType' => [ 'type' => 'string', 'enum' => [ 'ScheduledAssessmentFailure', 'DriftDetected', ], ], 'ExcludeRecommendationReason' => [ 'type' => 'string', 'enum' => [ 'AlreadyImplemented', 'NotRelevant', 'ComplexityOfImplementation', ], ], 'FailurePolicy' => [ 'type' => 'structure', 'required' => [ 'rpoInSecs', 'rtoInSecs', ], 'members' => [ 'rpoInSecs' => [ 'shape' => 'Seconds', ], 'rtoInSecs' => [ 'shape' => 'Seconds', ], ], ], 'HaArchitecture' => [ 'type' => 'string', 'enum' => [ 'MultiSite', 'WarmStandby', 'PilotLight', 'BackupAndRestore', 'NoRecoveryPlan', ], ], 'IamRoleArn' => [ 'type' => 'string', 'pattern' => '^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):iam::[0-9]{12}:role/(([^/][!-~]+/){1,511})?[A-Za-z0-9_+=,.@-]{1,64}$', ], 'IamRoleArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IamRoleArn', ], 'max' => 10, 'min' => 0, ], 'IamRoleName' => [ 'type' => 'string', 'pattern' => '^([^/]([!-~]+/){1,511})?[A-Za-z0-9_+=,.@-]{1,64}$', ], 'ImportResourcesToDraftAppVersionRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'eksSources' => [ 'shape' => 'EksSourceList', ], 'importStrategy' => [ 'shape' => 'ResourceImportStrategyType', ], 'sourceArns' => [ 'shape' => 'ArnList', ], 'terraformSources' => [ 'shape' => 'TerraformSourceList', ], ], ], 'ImportResourcesToDraftAppVersionResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'status', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'eksSources' => [ 'shape' => 'EksSourceList', ], 'sourceArns' => [ 'shape' => 'ArnList', ], 'status' => [ 'shape' => 'ResourceImportStatusType', ], 'terraformSources' => [ 'shape' => 'TerraformSourceList', ], ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'ListAlarmRecommendationsRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAlarmRecommendationsResponse' => [ 'type' => 'structure', 'required' => [ 'alarmRecommendations', ], 'members' => [ 'alarmRecommendations' => [ 'shape' => 'AlarmRecommendationList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppAssessmentComplianceDriftsRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppAssessmentComplianceDriftsResponse' => [ 'type' => 'structure', 'required' => [ 'complianceDrifts', ], 'members' => [ 'complianceDrifts' => [ 'shape' => 'ComplianceDriftList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppAssessmentsRequest' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'appArn', ], 'assessmentName' => [ 'shape' => 'EntityName', 'location' => 'querystring', 'locationName' => 'assessmentName', ], 'assessmentStatus' => [ 'shape' => 'AssessmentStatusList', 'location' => 'querystring', 'locationName' => 'assessmentStatus', ], 'complianceStatus' => [ 'shape' => 'ComplianceStatus', 'location' => 'querystring', 'locationName' => 'complianceStatus', ], 'invoker' => [ 'shape' => 'AssessmentInvoker', 'location' => 'querystring', 'locationName' => 'invoker', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'reverseOrder' => [ 'shape' => 'BooleanOptional', 'location' => 'querystring', 'locationName' => 'reverseOrder', ], ], ], 'ListAppAssessmentsResponse' => [ 'type' => 'structure', 'required' => [ 'assessmentSummaries', ], 'members' => [ 'assessmentSummaries' => [ 'shape' => 'AppAssessmentSummaryList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppComponentCompliancesRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppComponentCompliancesResponse' => [ 'type' => 'structure', 'required' => [ 'componentCompliances', ], 'members' => [ 'componentCompliances' => [ 'shape' => 'ComponentCompliancesList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppComponentRecommendationsRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppComponentRecommendationsResponse' => [ 'type' => 'structure', 'required' => [ 'componentRecommendations', ], 'members' => [ 'componentRecommendations' => [ 'shape' => 'ComponentRecommendationList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppInputSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppInputSourcesResponse' => [ 'type' => 'structure', 'required' => [ 'appInputSources', ], 'members' => [ 'appInputSources' => [ 'shape' => 'AppInputSourceList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppVersionAppComponentsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppVersionAppComponentsResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponents' => [ 'shape' => 'AppComponentList', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppVersionResourceMappingsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppVersionResourceMappingsResponse' => [ 'type' => 'structure', 'required' => [ 'resourceMappings', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'resourceMappings' => [ 'shape' => 'ResourceMappingList', ], ], ], 'ListAppVersionResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'resolutionId' => [ 'shape' => 'String255', ], ], ], 'ListAppVersionResourcesResponse' => [ 'type' => 'structure', 'required' => [ 'physicalResources', 'resolutionId', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'physicalResources' => [ 'shape' => 'PhysicalResourceList', ], 'resolutionId' => [ 'shape' => 'String255', ], ], ], 'ListAppVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'endTime' => [ 'shape' => 'TimeStamp', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'startTime' => [ 'shape' => 'TimeStamp', ], ], ], 'ListAppVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'appVersions', ], 'members' => [ 'appVersions' => [ 'shape' => 'AppVersionList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppsRequest' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'appArn', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'name' => [ 'shape' => 'EntityName', 'location' => 'querystring', 'locationName' => 'name', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListAppsResponse' => [ 'type' => 'structure', 'required' => [ 'appSummaries', ], 'members' => [ 'appSummaries' => [ 'shape' => 'AppSummaryList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRecommendationTemplatesRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'assessmentArn', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'name' => [ 'shape' => 'EntityName', 'location' => 'querystring', 'locationName' => 'name', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'recommendationTemplateArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'recommendationTemplateArn', ], 'reverseOrder' => [ 'shape' => 'BooleanOptional', 'location' => 'querystring', 'locationName' => 'reverseOrder', ], 'status' => [ 'shape' => 'RecommendationTemplateStatusList', 'location' => 'querystring', 'locationName' => 'status', ], ], ], 'ListRecommendationTemplatesResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'recommendationTemplates' => [ 'shape' => 'RecommendationTemplateList', ], ], ], 'ListResiliencyPoliciesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'policyName' => [ 'shape' => 'EntityName', 'location' => 'querystring', 'locationName' => 'policyName', ], ], ], 'ListResiliencyPoliciesResponse' => [ 'type' => 'structure', 'required' => [ 'resiliencyPolicies', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'resiliencyPolicies' => [ 'shape' => 'ResiliencyPolicies', ], ], ], 'ListSopRecommendationsRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSopRecommendationsResponse' => [ 'type' => 'structure', 'required' => [ 'sopRecommendations', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'sopRecommendations' => [ 'shape' => 'SopRecommendationList', ], ], ], 'ListSuggestedResiliencyPoliciesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListSuggestedResiliencyPoliciesResponse' => [ 'type' => 'structure', 'required' => [ 'resiliencyPolicies', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'resiliencyPolicies' => [ 'shape' => 'ResiliencyPolicies', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ListTestRecommendationsRequest' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', ], 'members' => [ 'assessmentArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTestRecommendationsResponse' => [ 'type' => 'structure', 'required' => [ 'testRecommendations', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'testRecommendations' => [ 'shape' => 'TestRecommendationList', ], ], ], 'ListUnsupportedAppVersionResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'resolutionId' => [ 'shape' => 'String255', ], ], ], 'ListUnsupportedAppVersionResourcesResponse' => [ 'type' => 'structure', 'required' => [ 'resolutionId', 'unsupportedResources', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'resolutionId' => [ 'shape' => 'String255', ], 'unsupportedResources' => [ 'shape' => 'UnsupportedResourceList', ], ], ], 'LogicalResourceId' => [ 'type' => 'structure', 'required' => [ 'identifier', ], 'members' => [ 'eksSourceName' => [ 'shape' => 'String255', ], 'identifier' => [ 'shape' => 'String255', ], 'logicalStackName' => [ 'shape' => 'String255', ], 'resourceGroupName' => [ 'shape' => 'EntityName', ], 'terraformSourceName' => [ 'shape' => 'String255', ], ], ], 'LongOptional' => [ 'type' => 'long', 'box' => true, ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'NextToken' => [ 'type' => 'string', 'pattern' => '^\\S{1,2000}$', ], 'PermissionModel' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'crossAccountRoleArns' => [ 'shape' => 'IamRoleArnList', ], 'invokerRoleName' => [ 'shape' => 'IamRoleName', ], 'type' => [ 'shape' => 'PermissionModelType', ], ], ], 'PermissionModelType' => [ 'type' => 'string', 'enum' => [ 'LegacyIAMUser', 'RoleBased', ], ], 'PhysicalIdentifierType' => [ 'type' => 'string', 'enum' => [ 'Arn', 'Native', ], ], 'PhysicalResource' => [ 'type' => 'structure', 'required' => [ 'logicalResourceId', 'physicalResourceId', 'resourceType', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appComponents' => [ 'shape' => 'AppComponentList', ], 'excluded' => [ 'shape' => 'BooleanOptional', ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'parentResourceName' => [ 'shape' => 'EntityName', ], 'physicalResourceId' => [ 'shape' => 'PhysicalResourceId', ], 'resourceName' => [ 'shape' => 'EntityName', ], 'resourceType' => [ 'shape' => 'String255', ], 'sourceType' => [ 'shape' => 'ResourceSourceType', ], ], ], 'PhysicalResourceId' => [ 'type' => 'structure', 'required' => [ 'identifier', 'type', ], 'members' => [ 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'identifier' => [ 'shape' => 'String255', ], 'type' => [ 'shape' => 'PhysicalIdentifierType', ], ], ], 'PhysicalResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhysicalResource', ], ], 'PublishAppVersionRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'versionName' => [ 'shape' => 'EntityVersion', ], ], ], 'PublishAppVersionResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'identifier' => [ 'shape' => 'LongOptional', ], 'versionName' => [ 'shape' => 'EntityVersion', ], ], ], 'PutDraftAppVersionTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appTemplateBody', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appTemplateBody' => [ 'shape' => 'AppTemplateBody', ], ], ], 'PutDraftAppVersionTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'RecommendationCompliance' => [ 'type' => 'map', 'key' => [ 'shape' => 'DisruptionType', ], 'value' => [ 'shape' => 'RecommendationDisruptionCompliance', ], ], 'RecommendationComplianceStatus' => [ 'type' => 'string', 'enum' => [ 'BreachedUnattainable', 'BreachedCanMeet', 'MetCanImprove', ], ], 'RecommendationDisruptionCompliance' => [ 'type' => 'structure', 'required' => [ 'expectedComplianceStatus', ], 'members' => [ 'expectedComplianceStatus' => [ 'shape' => 'ComplianceStatus', ], 'expectedRpoDescription' => [ 'shape' => 'String500', ], 'expectedRpoInSecs' => [ 'shape' => 'Seconds', ], 'expectedRtoDescription' => [ 'shape' => 'String500', ], 'expectedRtoInSecs' => [ 'shape' => 'Seconds', ], ], ], 'RecommendationIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Uuid', ], 'max' => 200, 'min' => 1, ], 'RecommendationItem' => [ 'type' => 'structure', 'members' => [ 'alreadyImplemented' => [ 'shape' => 'BooleanOptional', ], 'excludeReason' => [ 'shape' => 'ExcludeRecommendationReason', ], 'excluded' => [ 'shape' => 'BooleanOptional', ], 'resourceId' => [ 'shape' => 'String500', ], 'targetAccountId' => [ 'shape' => 'CustomerId', ], 'targetRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'RecommendationItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationItem', ], ], 'RecommendationTemplate' => [ 'type' => 'structure', 'required' => [ 'assessmentArn', 'format', 'name', 'recommendationTemplateArn', 'recommendationTypes', 'status', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'assessmentArn' => [ 'shape' => 'Arn', ], 'endTime' => [ 'shape' => 'TimeStamp', ], 'format' => [ 'shape' => 'TemplateFormat', ], 'message' => [ 'shape' => 'String500', ], 'name' => [ 'shape' => 'EntityName', ], 'needsReplacements' => [ 'shape' => 'BooleanOptional', ], 'recommendationIds' => [ 'shape' => 'RecommendationIdList', ], 'recommendationTemplateArn' => [ 'shape' => 'Arn', ], 'recommendationTypes' => [ 'shape' => 'RenderRecommendationTypeList', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'status' => [ 'shape' => 'RecommendationTemplateStatus', ], 'tags' => [ 'shape' => 'TagMap', ], 'templatesLocation' => [ 'shape' => 'S3Location', ], ], ], 'RecommendationTemplateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationTemplate', ], ], 'RecommendationTemplateStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Failed', 'Success', ], ], 'RecommendationTemplateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationTemplateStatus', ], 'max' => 4, 'min' => 1, ], 'RemoveDraftAppVersionResourceMappingsRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appRegistryAppNames' => [ 'shape' => 'EntityNameList', ], 'eksSourceNames' => [ 'shape' => 'String255List', ], 'logicalStackNames' => [ 'shape' => 'String255List', ], 'resourceGroupNames' => [ 'shape' => 'EntityNameList', ], 'resourceNames' => [ 'shape' => 'EntityNameList', ], 'terraformSourceNames' => [ 'shape' => 'String255List', ], ], ], 'RemoveDraftAppVersionResourceMappingsResponse' => [ 'type' => 'structure', 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'RenderRecommendationType' => [ 'type' => 'string', 'enum' => [ 'Alarm', 'Sop', 'Test', ], ], 'RenderRecommendationTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RenderRecommendationType', ], 'max' => 4, 'min' => 1, ], 'ResiliencyPolicies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResiliencyPolicy', ], ], 'ResiliencyPolicy' => [ 'type' => 'structure', 'members' => [ 'creationTime' => [ 'shape' => 'TimeStamp', ], 'dataLocationConstraint' => [ 'shape' => 'DataLocationConstraint', ], 'estimatedCostTier' => [ 'shape' => 'EstimatedCostTier', ], 'policy' => [ 'shape' => 'DisruptionPolicy', ], 'policyArn' => [ 'shape' => 'Arn', ], 'policyDescription' => [ 'shape' => 'EntityDescription', ], 'policyName' => [ 'shape' => 'EntityName', ], 'tags' => [ 'shape' => 'TagMap', ], 'tier' => [ 'shape' => 'ResiliencyPolicyTier', ], ], ], 'ResiliencyPolicyTier' => [ 'type' => 'string', 'enum' => [ 'MissionCritical', 'Critical', 'Important', 'CoreServices', 'NonCritical', 'NotApplicable', ], ], 'ResiliencyScore' => [ 'type' => 'structure', 'required' => [ 'disruptionScore', 'score', ], 'members' => [ 'disruptionScore' => [ 'shape' => 'DisruptionResiliencyScore', ], 'score' => [ 'shape' => 'Double', ], ], ], 'ResolveAppVersionResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'ResolveAppVersionResourcesResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'resolutionId', 'status', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'resolutionId' => [ 'shape' => 'String255', ], 'status' => [ 'shape' => 'ResourceResolutionStatusType', ], ], ], 'ResourceError' => [ 'type' => 'structure', 'members' => [ 'logicalResourceId' => [ 'shape' => 'String255', ], 'physicalResourceId' => [ 'shape' => 'String255', ], 'reason' => [ 'shape' => 'ErrorMessage', ], ], ], 'ResourceErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceError', ], ], 'ResourceErrorsDetails' => [ 'type' => 'structure', 'members' => [ 'hasMoreErrors' => [ 'shape' => 'BooleanOptional', ], 'resourceErrors' => [ 'shape' => 'ResourceErrorList', ], ], ], 'ResourceId' => [ 'type' => 'string', 'pattern' => '.*', ], 'ResourceImportStatusType' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Failed', 'Success', ], ], 'ResourceImportStrategyType' => [ 'type' => 'string', 'enum' => [ 'AddOnly', 'ReplaceAll', ], ], 'ResourceMapping' => [ 'type' => 'structure', 'required' => [ 'mappingType', 'physicalResourceId', ], 'members' => [ 'appRegistryAppName' => [ 'shape' => 'EntityName', ], 'eksSourceName' => [ 'shape' => 'String255', ], 'logicalStackName' => [ 'shape' => 'String255', ], 'mappingType' => [ 'shape' => 'ResourceMappingType', ], 'physicalResourceId' => [ 'shape' => 'PhysicalResourceId', ], 'resourceGroupName' => [ 'shape' => 'EntityName', ], 'resourceName' => [ 'shape' => 'EntityName', ], 'terraformSourceName' => [ 'shape' => 'String255', ], ], ], 'ResourceMappingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceMapping', ], ], 'ResourceMappingType' => [ 'type' => 'string', 'enum' => [ 'CfnStack', 'Resource', 'AppRegistryApp', 'ResourceGroup', 'Terraform', 'EKS', ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourceResolutionStatusType' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Failed', 'Success', ], ], 'ResourceSourceType' => [ 'type' => 'string', 'enum' => [ 'AppTemplate', 'Discovered', ], ], 'ResourceType' => [ 'type' => 'string', 'pattern' => '.*', ], 'RetryAfterSeconds' => [ 'type' => 'integer', 'box' => true, ], 'S3Location' => [ 'type' => 'structure', 'members' => [ 'bucket' => [ 'shape' => 'String500', ], 'prefix' => [ 'shape' => 'String500', ], ], ], 'S3Url' => [ 'type' => 'string', 'max' => 2000, 'min' => 0, 'pattern' => '^((https://([^/]+)\\.s3((-|\\.)[^/]+)?\\.amazonaws\\.com(.cn)?)|(s3://([^/]+)))/\\S{1,2000}$', ], 'Seconds' => [ 'type' => 'integer', 'min' => 0, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'SopRecommendation' => [ 'type' => 'structure', 'required' => [ 'recommendationId', 'referenceId', 'serviceType', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'description' => [ 'shape' => 'String500', ], 'items' => [ 'shape' => 'RecommendationItemList', ], 'name' => [ 'shape' => 'DocumentName', ], 'prerequisite' => [ 'shape' => 'String500', ], 'recommendationId' => [ 'shape' => 'Uuid', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], 'serviceType' => [ 'shape' => 'SopServiceType', ], ], ], 'SopRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SopRecommendation', ], ], 'SopServiceType' => [ 'type' => 'string', 'enum' => [ 'SSM', ], ], 'SpecReferenceId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'StartAppAssessmentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', 'assessmentName', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'assessmentName' => [ 'shape' => 'EntityName', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'StartAppAssessmentResponse' => [ 'type' => 'structure', 'required' => [ 'assessment', ], 'members' => [ 'assessment' => [ 'shape' => 'AppAssessment', ], ], ], 'String1024' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'String128WithoutWhitespace' => [ 'type' => 'string', 'pattern' => '^\\S{1,128}$', ], 'String2048' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'String255' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'String255List' => [ 'type' => 'list', 'member' => [ 'shape' => 'String255', ], ], 'String500' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'SuggestedChangesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntityDescription', ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^(?!aws:)[^\\x00-\\x1f\\x22]+$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, 'sensitive' => true, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 50, 'min' => 1, 'sensitive' => true, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^[^\\x00-\\x1f\\x22]*$', ], 'TemplateFormat' => [ 'type' => 'string', 'enum' => [ 'CfnYaml', 'CfnJson', ], ], 'TerraformSource' => [ 'type' => 'structure', 'required' => [ 's3StateFileUrl', ], 'members' => [ 's3StateFileUrl' => [ 'shape' => 'S3Url', ], ], ], 'TerraformSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TerraformSource', ], ], 'TestRecommendation' => [ 'type' => 'structure', 'required' => [ 'referenceId', ], 'members' => [ 'appComponentName' => [ 'shape' => 'EntityId', ], 'dependsOnAlarms' => [ 'shape' => 'AlarmReferenceIdList', ], 'description' => [ 'shape' => 'String500', ], 'intent' => [ 'shape' => 'EntityDescription', ], 'items' => [ 'shape' => 'RecommendationItemList', ], 'name' => [ 'shape' => 'DocumentName', ], 'prerequisite' => [ 'shape' => 'String500', ], 'recommendationId' => [ 'shape' => 'Uuid', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], 'risk' => [ 'shape' => 'TestRisk', ], 'type' => [ 'shape' => 'TestType', ], ], ], 'TestRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TestRecommendation', ], ], 'TestRisk' => [ 'type' => 'string', 'enum' => [ 'Small', 'Medium', 'High', ], ], 'TestType' => [ 'type' => 'string', 'enum' => [ 'Software', 'Hardware', 'AZ', 'Region', ], ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], 'retryAfterSeconds' => [ 'shape' => 'RetryAfterSeconds', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'TimeStamp' => [ 'type' => 'timestamp', ], 'UnsupportedResource' => [ 'type' => 'structure', 'required' => [ 'logicalResourceId', 'physicalResourceId', 'resourceType', ], 'members' => [ 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'PhysicalResourceId', ], 'resourceType' => [ 'shape' => 'String255', ], 'unsupportedResourceStatus' => [ 'shape' => 'String255', ], ], ], 'UnsupportedResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UnsupportedResource', ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAppRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'assessmentSchedule' => [ 'shape' => 'AppAssessmentScheduleType', ], 'clearResiliencyPolicyArn' => [ 'shape' => 'BooleanOptional', ], 'description' => [ 'shape' => 'EntityDescription', ], 'eventSubscriptions' => [ 'shape' => 'EventSubscriptionList', ], 'permissionModel' => [ 'shape' => 'PermissionModel', ], 'policyArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateAppResponse' => [ 'type' => 'structure', 'required' => [ 'app', ], 'members' => [ 'app' => [ 'shape' => 'App', ], ], ], 'UpdateAppVersionAppComponentRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', 'id', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'id' => [ 'shape' => 'String255', ], 'name' => [ 'shape' => 'String255', ], 'type' => [ 'shape' => 'String255', ], ], ], 'UpdateAppVersionAppComponentResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appComponent' => [ 'shape' => 'AppComponent', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'UpdateAppVersionRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateAppVersionResourceRequest' => [ 'type' => 'structure', 'required' => [ 'appArn', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'appComponents' => [ 'shape' => 'AppComponentNameList', ], 'awsAccountId' => [ 'shape' => 'CustomerId', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'excluded' => [ 'shape' => 'BooleanOptional', ], 'logicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'physicalResourceId' => [ 'shape' => 'String2048', ], 'resourceName' => [ 'shape' => 'EntityName', ], 'resourceType' => [ 'shape' => 'String255', ], ], ], 'UpdateAppVersionResourceResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], 'physicalResource' => [ 'shape' => 'PhysicalResource', ], ], ], 'UpdateAppVersionResponse' => [ 'type' => 'structure', 'required' => [ 'appArn', 'appVersion', ], 'members' => [ 'additionalInfo' => [ 'shape' => 'AdditionalInfoMap', ], 'appArn' => [ 'shape' => 'Arn', ], 'appVersion' => [ 'shape' => 'EntityVersion', ], ], ], 'UpdateRecommendationStatusItem' => [ 'type' => 'structure', 'members' => [ 'resourceId' => [ 'shape' => 'String500', ], 'targetAccountId' => [ 'shape' => 'CustomerId', ], 'targetRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'UpdateRecommendationStatusRequestEntries' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdateRecommendationStatusRequestEntry', ], 'max' => 50, 'min' => 1, ], 'UpdateRecommendationStatusRequestEntry' => [ 'type' => 'structure', 'required' => [ 'entryId', 'excluded', 'item', 'referenceId', ], 'members' => [ 'entryId' => [ 'shape' => 'String255', ], 'excludeReason' => [ 'shape' => 'ExcludeRecommendationReason', ], 'excluded' => [ 'shape' => 'BooleanOptional', ], 'item' => [ 'shape' => 'UpdateRecommendationStatusItem', ], 'referenceId' => [ 'shape' => 'SpecReferenceId', ], ], ], 'UpdateResiliencyPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyArn', ], 'members' => [ 'dataLocationConstraint' => [ 'shape' => 'DataLocationConstraint', ], 'policy' => [ 'shape' => 'DisruptionPolicy', ], 'policyArn' => [ 'shape' => 'Arn', ], 'policyDescription' => [ 'shape' => 'EntityDescription', ], 'policyName' => [ 'shape' => 'EntityName', ], 'tier' => [ 'shape' => 'ResiliencyPolicyTier', ], ], ], 'UpdateResiliencyPolicyResponse' => [ 'type' => 'structure', 'required' => [ 'policy', ], 'members' => [ 'policy' => [ 'shape' => 'ResiliencyPolicy', ], ], ], 'Uuid' => [ 'type' => 'string', 'pattern' => '^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$', ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String500', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], ],]; diff --git a/src/data/resiliencehub/2020-04-30/docs-2.json b/src/data/resiliencehub/2020-04-30/docs-2.json index b8f05dd13b..67e5cfaa24 100644 --- a/src/data/resiliencehub/2020-04-30/docs-2.json +++ b/src/data/resiliencehub/2020-04-30/docs-2.json @@ -3,7 +3,8 @@ "service": "Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. It offers continual resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production.
", "operations": { "AddDraftAppVersionResourceMappings": "Adds the resource mapping for the draft application version. You can also update an existing resource mapping to a new physical resource.
", - "CreateApp": "Creates an Resilience Hub application. An Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe an Resilience Hub application, you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. For more information about the number of resources supported per application, see Service Quotas.
After you create an Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).
", + "BatchUpdateRecommendationStatus": "Enables you to include or exclude one or more operational recommendations.
", + "CreateApp": "Creates an Resilience Hub application. An Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas.
After you create an Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).
", "CreateAppVersionAppComponent": "Creates a new Application Component in the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Adds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must call ResolveAppVersionResources API.
Creates a new recommendation template for the Resilience Hub application.
", @@ -26,6 +27,7 @@ "DescribeResiliencyPolicy": "Describes a specified resiliency policy for an Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.
", "ImportResourcesToDraftAppVersion": "Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
", "ListAlarmRecommendations": "Lists the alarm recommendations for an Resilience Hub application.
", + "ListAppAssessmentComplianceDrifts": "List of compliance drifts that were detected while running an assessment.
", "ListAppAssessments": "Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.
", "ListAppComponentCompliances": "Lists the compliances for an Resilience Hub Application Component.
", "ListAppComponentRecommendations": "Lists the recommendations for an Resilience Hub Application Component.
", @@ -112,7 +114,7 @@ "AlarmType": { "base": null, "refs": { - "AlarmRecommendation$type": "The type of alarm recommendation.
" + "AlarmRecommendation$type": "Type of alarm recommendation.
" } }, "App": { @@ -133,7 +135,7 @@ "AppAssessmentScheduleType": { "base": null, "refs": { - "App$assessmentSchedule": "Assessment execution schedule with 'Daily' or 'Disabled' values.
", + "App$assessmentSchedule": "Assessment execution schedule with 'Daily' or 'Disabled' values.
", "AppSummary$assessmentSchedule": "Assessment execution schedule with 'Daily' or 'Disabled' values.
", "CreateAppRequest$assessmentSchedule": "Assessment execution schedule with 'Daily' or 'Disabled' values.
", "UpdateAppRequest$assessmentSchedule": "Assessment execution schedule with 'Daily' or 'Disabled' values.
" @@ -154,7 +156,7 @@ "AppComplianceStatusType": { "base": null, "refs": { - "App$complianceStatus": "The current status of compliance for the resiliency policy.
", + "App$complianceStatus": "Current status of compliance for the resiliency policy.
", "AppSummary$complianceStatus": "The current status of compliance for the resiliency policy.
" } }, @@ -162,10 +164,10 @@ "base": "Defines an Application Component.
", "refs": { "AppComponentList$member": null, - "CreateAppVersionAppComponentResponse$appComponent": "The list of Application Components that belong to this resource.
", - "DeleteAppVersionAppComponentResponse$appComponent": "The list of Application Components that belong to this resource.
", - "DescribeAppVersionAppComponentResponse$appComponent": "The list of Application Components that belong to this resource.
", - "UpdateAppVersionAppComponentResponse$appComponent": "The list of Application Components that belong to this resource.
" + "CreateAppVersionAppComponentResponse$appComponent": "List of Application Components that belong to this resource.
", + "DeleteAppVersionAppComponentResponse$appComponent": "List of Application Components that belong to this resource.
", + "DescribeAppVersionAppComponentResponse$appComponent": "List of Application Components that belong to this resource.
", + "UpdateAppVersionAppComponentResponse$appComponent": "List of Application Components that belong to this resource.
" } }, "AppComponentCompliance": { @@ -184,15 +186,23 @@ "AppComponentNameList": { "base": null, "refs": { - "CreateAppVersionResourceRequest$appComponents": "The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
", - "UpdateAppVersionResourceRequest$appComponents": "The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
" + "AlarmRecommendation$appComponentNames": "List of Application Component names for the CloudWatch alarm recommendation.
", + "CreateAppVersionResourceRequest$appComponents": "List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
", + "UpdateAppVersionResourceRequest$appComponents": "List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
" + } + }, + "AppDriftStatusType": { + "base": null, + "refs": { + "App$driftStatus": "Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
", + "AppSummary$driftStatus": "Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
" } }, "AppInputSource": { "base": "The list of Resilience Hub application input sources.
", "refs": { "AppInputSourceList$member": null, - "DeleteAppInputSourceResponse$appInputSource": "The name of the input source from where the application resource is imported from.
" + "DeleteAppInputSourceResponse$appInputSource": "Name of the input source from where the application resource is imported from.
" } }, "AppInputSourceList": { @@ -204,8 +214,8 @@ "AppStatusType": { "base": null, "refs": { - "App$status": "The status of the application.
", - "AppSummary$status": "The status of the application.
" + "App$status": "Status of the application.
", + "AppSummary$status": "Status of the application.
" } }, "AppSummary": { @@ -223,8 +233,8 @@ "AppTemplateBody": { "base": null, "refs": { - "DescribeAppVersionTemplateResponse$appTemplateBody": "A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.
The appTemplateBody JSON string has the following structure:
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don't add the resources that you want to exclude.
Each resources array item includes the following fields:
logicalResourceId
The logical identifier of the resource.
Type: Object
Each logicalResourceId object includes the following fields:
identifier
The identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Type: String
type
The type of resource.
Type: string
name
The name of the resource.
Type: String
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
appComponents
The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each appComponents array item includes the following fields:
name
The name of the Application Component.
Type: String
type
The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don't add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
The logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
Each logicalResourceIds object includes the following fields:
identifier
The identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Type: String
version
The Resilience Hub application version.
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.
The appTemplateBody JSON string has the following structure:
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don't add the resources that you want to exclude.
Each resources array item includes the following fields:
logicalResourceId
The logical identifier of the resource.
Type: Object
Each logicalResourceId object includes the following fields:
identifier
The identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Type: String
type
The type of resource.
Type: string
name
The name of the resource.
Type: String
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
appComponents
The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each appComponents array item includes the following fields:
name
The name of the Application Component.
Type: String
type
The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don't add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
The logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
Each logicalResourceIds object includes the following fields:
identifier
The identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Type: String
version
The Resilience Hub application version.
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.
The appTemplateBody JSON string has the following structure:
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don't add the resources that you want to exclude.
Each resources array item includes the following fields:
logicalResourceId
Logical identifier of the resource.
Type: Object
Each logicalResourceId object includes the following fields:
identifier
Identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Type: String
type
The type of resource.
Type: string
name
The name of the resource.
Type: String
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
appComponents
List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each appComponents array item includes the following fields:
name
Name of the Application Component.
Type: String
type
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don't add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
Logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
Each logicalResourceIds object includes the following fields:
identifier
Identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Type: String
version
Resilience Hub application version.
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.
The appTemplateBody JSON string has the following structure:
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don't add the resources that you want to exclude.
Each resources array item includes the following fields:
logicalResourceId
Logical identifier of the resource.
Type: Object
Each logicalResourceId object includes the following fields:
identifier
Identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Type: String
type
The type of resource.
Type: string
name
The name of the resource.
Type: String
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
appComponents
List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each appComponents array item includes the following fields:
name
Name of the Application Component.
Type: String
type
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don't add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
Logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
Each logicalResourceIds object includes the following fields:
identifier
Identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Type: String
version
Resilience Hub application version.
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: \"failover-regions\"
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
The version of the application.
", + "base": "Version of an application.
", "refs": { "AppVersionList$member": null } @@ -242,98 +252,102 @@ "Arn": { "base": null, "refs": { - "AddDraftAppVersionResourceMappingsRequest$appArn": "The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
", - "AppSummary$appArn": "The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the imported resource you want to remove from the Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
", - "DeleteAppInputSourceResponse$appArn": "The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for a recommendation template.
", "DeleteRecommendationTemplateResponse$recommendationTemplateArn": "The Amazon Resource Name (ARN) for a recommendation template.
", - "DeleteResiliencyPolicyRequest$policyArn": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for a recommendation template.
", - "ListSopRecommendationsRequest$assessmentArn": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.
", - "ListTestRecommendationsRequest$assessmentArn": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for the recommendation template.
", - "RemoveDraftAppVersionResourceMappingsRequest$appArn": "The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resource.
", - "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", - "UpdateAppRequest$appArn": "The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) for the recommendation template.
", + "RemoveDraftAppVersionResourceMappingsRequest$appArn": "Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resource.
", + "UntagResourceRequest$resourceArn": "Amazon Resource Name (ARN) of the resource.
", + "UpdateAppRequest$appArn": "Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The application compliance against the resiliency policy.
", + "AppAssessment$compliance": "Application compliance against the resiliency policy.
", "AppComponentCompliance$compliance": "The compliance of the Application Component against the resiliency policy.
", + "ComplianceDrift$actualValue": "Actual compliance value of the entity.
", + "ComplianceDrift$expectedValue": "The expected compliance value of an entity.
", "ConfigRecommendation$compliance": "The current compliance against the resiliency policy before applying the configuration change.
" } }, @@ -355,15 +371,15 @@ "base": null, "refs": { "AppAssessment$invoker": "The entity that invoked the assessment.
", - "AppAssessmentSummary$invoker": "The entity that invoked the assessment.
", + "AppAssessmentSummary$invoker": "Entity that invoked the assessment.
", "ListAppAssessmentsRequest$invoker": "Specifies the entity that invoked a specific assessment, either a User or the System.
The current status of the assessment for the resiliency policy.
", - "AppAssessmentSummary$assessmentStatus": "The current status of the assessment for the resiliency policy.
", + "AppAssessment$assessmentStatus": "Current status of the assessment for the resiliency policy.
", + "AppAssessmentSummary$assessmentStatus": "Current status of the assessment for the resiliency policy.
", "AssessmentStatusList$member": null, "DeleteAppAssessmentResponse$assessmentStatus": "The current status of the assessment for the resiliency policy.
" } @@ -377,26 +393,64 @@ "AwsRegion": { "base": null, "refs": { - "CreateAppVersionResourceRequest$awsRegion": "The Amazon Web Services region that owns the physical resource.
", - "DeleteAppVersionResourceRequest$awsRegion": "The Amazon Web Services region that owns the physical resource.
", - "DescribeAppVersionResourceRequest$awsRegion": "The Amazon Web Services region that owns the physical resource.
", + "CreateAppVersionResourceRequest$awsRegion": "Amazon Web Services region that owns the physical resource.
", + "DeleteAppVersionResourceRequest$awsRegion": "Amazon Web Services region that owns the physical resource.
", + "DescribeAppVersionResourceRequest$awsRegion": "Amazon Web Services region that owns the physical resource.
", "PhysicalResourceId$awsRegion": "The Amazon Web Services Region that the physical resource is located in.
", "RecommendationItem$targetRegion": "The target region.
", - "UpdateAppVersionResourceRequest$awsRegion": "The Amazon Web Services region that owns the physical resource.
" + "UpdateAppVersionResourceRequest$awsRegion": "Amazon Web Services region that owns the physical resource.
", + "UpdateRecommendationStatusItem$targetRegion": "Identifier of the target Amazon Web Services Region.
" + } + }, + "BatchUpdateRecommendationStatusFailedEntries": { + "base": null, + "refs": { + "BatchUpdateRecommendationStatusResponse$failedEntries": "A list of items with error details about each item, which could not be included or excluded.
" + } + }, + "BatchUpdateRecommendationStatusFailedEntry": { + "base": "List of operational recommendations that did not get included or excluded.
", + "refs": { + "BatchUpdateRecommendationStatusFailedEntries$member": null + } + }, + "BatchUpdateRecommendationStatusRequest": { + "base": null, + "refs": { + } + }, + "BatchUpdateRecommendationStatusResponse": { + "base": null, + "refs": { + } + }, + "BatchUpdateRecommendationStatusSuccessfulEntries": { + "base": null, + "refs": { + "BatchUpdateRecommendationStatusResponse$successfulEntries": "A list of items that were included or excluded.
" + } + }, + "BatchUpdateRecommendationStatusSuccessfulEntry": { + "base": "List of operational recommendations that were successfully included or excluded.
", + "refs": { + "BatchUpdateRecommendationStatusSuccessfulEntries$member": null } }, "BooleanOptional": { "base": null, "refs": { + "BatchUpdateRecommendationStatusSuccessfulEntry$excluded": "Indicates if the operational recommendation was successfully excluded.
", "DeleteAppRequest$forceDelete": "A boolean option to force the deletion of an Resilience Hub application.
", "ListAppAssessmentsRequest$reverseOrder": "The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.
The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.
Indicates if a resource is included or excluded from the assessment.
", "RecommendationItem$alreadyImplemented": "Specifies if the recommendation has already been implemented.
", + "RecommendationItem$excluded": "Indicates if an operational recommendation item is excluded.
", "RecommendationTemplate$needsReplacements": "Indicates if replacements are needed.
", "ResourceErrorsDetails$hasMoreErrors": "This indicates if there are more errors not listed in the resourceErrors list.
", "UpdateAppRequest$clearResiliencyPolicyArn": "Specifies if the resiliency policy ARN should be cleared.
", - "UpdateAppVersionResourceRequest$excluded": "Indicates if a resource is excluded from an Resilience Hub application.
You can exclude only imported resources from an Resilience Hub application.
Indicates if a resource is excluded from an Resilience Hub application.
You can exclude only imported resources from an Resilience Hub application.
Indicates if the operational recommendation needs to be excluded. If set to True, the operational recommendation will be excluded.
" } }, "ClientToken": { @@ -417,12 +471,24 @@ "StartAppAssessmentRequest$clientToken": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
" } }, + "ComplianceDrift": { + "base": "Indicates the compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) that were detected for an assessed entity.
", + "refs": { + "ComplianceDriftList$member": null + } + }, + "ComplianceDriftList": { + "base": null, + "refs": { + "ListAppAssessmentComplianceDriftsResponse$complianceDrifts": "Indicates compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) detected for an assessed entity.
" + } + }, "ComplianceStatus": { "base": null, "refs": { - "AppAssessment$complianceStatus": "The current status of the compliance for the resiliency policy.
", - "AppAssessmentSummary$complianceStatus": "The current status of compliance for the resiliency policy.
", - "AppComponentCompliance$status": "The status of the action.
", + "AppAssessment$complianceStatus": "Current status of the compliance for the resiliency policy.
", + "AppAssessmentSummary$complianceStatus": "TCurrent status of compliance for the resiliency policy.
", + "AppComponentCompliance$status": "Status of the action.
", "DisruptionCompliance$complianceStatus": "The current status of compliance for the resiliency policy.
", "ListAppAssessmentsRequest$complianceStatus": "The current status of compliance for the resiliency policy.
", "RecommendationDisruptionCompliance$expectedComplianceStatus": "The expected compliance status after applying the recommended configuration change.
" @@ -447,7 +513,7 @@ } }, "ConfigRecommendation": { - "base": "Defines a configuration recommendation.
", + "base": "Defines a recommendation configuration.
", "refs": { "ConfigRecommendationList$member": null } @@ -455,7 +521,7 @@ "ConfigRecommendationList": { "base": null, "refs": { - "ComponentRecommendation$configRecommendations": "The list of recommendations.
" + "ComponentRecommendation$configRecommendations": "List of recommendations.
" } }, "ConfigRecommendationOptimizationType": { @@ -472,8 +538,8 @@ "Cost": { "base": "Defines a cost object.
", "refs": { - "AppAssessment$cost": "The cost for the application.
", - "AppAssessmentSummary$cost": "The cost for the application.
", + "AppAssessment$cost": "Cost for the application.
", + "AppAssessmentSummary$cost": "Cost for an application.
", "AppComponentCompliance$cost": "The cost for the application.
", "ConfigRecommendation$cost": "The cost for the application.
" } @@ -543,12 +609,13 @@ "CustomerId": { "base": null, "refs": { - "CreateAppVersionResourceRequest$awsAccountId": "The Amazon Web Services account that owns the physical resource.
", - "DeleteAppVersionResourceRequest$awsAccountId": "The Amazon Web Services account that owns the physical resource.
", - "DescribeAppVersionResourceRequest$awsAccountId": "The Amazon Web Services account that owns the physical resource.
", + "CreateAppVersionResourceRequest$awsAccountId": "Amazon Web Services account that owns the physical resource.
", + "DeleteAppVersionResourceRequest$awsAccountId": "Amazon Web Services account that owns the physical resource.
", + "DescribeAppVersionResourceRequest$awsAccountId": "Amazon Web Services account that owns the physical resource.
", "PhysicalResourceId$awsAccountId": "The Amazon Web Services account that owns the physical resource.
", - "RecommendationItem$targetAccountId": "The target account identifier.
", - "UpdateAppVersionResourceRequest$awsAccountId": "The Amazon Web Services account that owns the physical resource.
" + "RecommendationItem$targetAccountId": "Identifier of the target account.
", + "UpdateAppVersionResourceRequest$awsAccountId": "Amazon Web Services account that owns the physical resource.
", + "UpdateRecommendationStatusItem$targetAccountId": "Identifier of the target Amazon Web Services account.
" } }, "DataLocationConstraint": { @@ -719,6 +786,12 @@ "refs": { } }, + "DifferenceType": { + "base": null, + "refs": { + "ComplianceDrift$diffType": "Difference type between actual and expected recovery point objective (RPO) and recovery time objective (RTO) values. Currently, Resilience Hub supports only NotEqual difference type.
" + } + }, "DisruptionCompliance": { "base": "Defines the compliance against the resiliency policy for a disruption.
", "refs": { @@ -751,21 +824,34 @@ "DocumentName": { "base": null, "refs": { - "SopRecommendation$name": "The name of the SOP recommendation.
", - "TestRecommendation$name": "The name of the test recommendation.
" + "SopRecommendation$name": "Name of the SOP recommendation.
", + "TestRecommendation$name": "Name of the test recommendation.
" } }, "Double": { "base": null, "refs": { - "App$resiliencyScore": "The current resiliency score for the application.
", - "AppAssessmentSummary$resiliencyScore": "The current resiliency score for the application.
", + "App$resiliencyScore": "Current resiliency score for the application.
", + "AppAssessmentSummary$resiliencyScore": "Current resiliency score for the application.
", "AppSummary$resiliencyScore": "The current resiliency score for the application.
", "Cost$amount": "The cost amount.
", "DisruptionResiliencyScore$value": null, "ResiliencyScore$score": "The outage score for a valid key.
" } }, + "DriftStatus": { + "base": null, + "refs": { + "AppAssessment$driftStatus": "Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
", + "AppAssessmentSummary$driftStatus": "Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
" + } + }, + "DriftType": { + "base": null, + "refs": { + "ComplianceDrift$driftType": "The type of drift detected. Currently, Resilience Hub supports only ApplicationCompliance drift type.
" + } + }, "EksNamespace": { "base": null, "refs": { @@ -802,15 +888,15 @@ "EntityDescription": { "base": null, "refs": { - "AlarmRecommendation$description": "The description of the recommendation.
", - "App$description": "The optional description for an app.
", + "AlarmRecommendation$description": "Description of the alarm recommendation.
", + "App$description": "Optional description for an application.
", "AppSummary$description": "The optional description for an app.
", "ConfigRecommendation$description": "The optional description for an app.
", "CreateAppRequest$description": "The optional description for an app.
", "CreateResiliencyPolicyRequest$policyDescription": "The description for the policy.
", "ResiliencyPolicy$policyDescription": "The description for the policy.
", "SuggestedChangesList$member": null, - "TestRecommendation$intent": "The intent of the test recommendation.
", + "TestRecommendation$intent": "Intent of the test recommendation.
", "UpdateAppRequest$description": "The optional description for an app.
", "UpdateResiliencyPolicyRequest$policyDescription": "The description for the policy.
" } @@ -818,44 +904,44 @@ "EntityId": { "base": null, "refs": { - "AlarmRecommendation$appComponentName": "The Application Component for the CloudWatch alarm recommendation.
", - "AppComponentCompliance$appComponentName": "The name of the Application Component.
", - "ComponentRecommendation$appComponentName": "The name of the Application Component.
", - "ConfigRecommendation$appComponentName": "The name of the Application Component.
", - "SopRecommendation$appComponentName": "The name of the Application Component.
", - "TestRecommendation$appComponentName": "The name of the Application Component.
" + "AlarmRecommendation$appComponentName": "Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list.
Name of the Application Component.
", + "ComponentRecommendation$appComponentName": "Name of the Application Component.
", + "ConfigRecommendation$appComponentName": "Name of the Application Component.
", + "SopRecommendation$appComponentName": "Name of the Application Component.
", + "TestRecommendation$appComponentName": "Name of the Application Component.
" } }, "EntityName": { "base": null, "refs": { - "App$name": "The name for the application.
", - "AppAssessment$assessmentName": "The name of the assessment.
", - "AppAssessmentSummary$assessmentName": "The name of the assessment.
", + "App$name": "Name for the application.
", + "AppAssessment$assessmentName": "Name of the assessment.
", + "AppAssessmentSummary$assessmentName": "Name of the assessment.
", "AppSummary$name": "The name of the application.
", "ConfigRecommendation$name": "The name of the recommendation configuration.
", - "CreateAppRequest$name": "The name for the application.
", - "CreateAppVersionResourceRequest$resourceName": "The name of the resource.
", + "CreateAppRequest$name": "Name of the application.
", + "CreateAppVersionResourceRequest$resourceName": "Name of the resource.
", "CreateRecommendationTemplateRequest$bucketName": "The name of the Amazon S3 bucket that will contain the recommendation template.
", "CreateRecommendationTemplateRequest$name": "The name for the recommendation template.
", "CreateResiliencyPolicyRequest$policyName": "The name of the policy
", - "DeleteAppVersionResourceRequest$resourceName": "The name of the resource.
", - "DescribeAppVersionResourceRequest$resourceName": "The name of the resource.
", + "DeleteAppVersionResourceRequest$resourceName": "Name of the resource.
", + "DescribeAppVersionResourceRequest$resourceName": "Name of the resource.
", "EntityNameList$member": null, "ListAppAssessmentsRequest$assessmentName": "The name for the assessment.
", "ListAppsRequest$name": "The name for the one of the listed applications.
", "ListRecommendationTemplatesRequest$name": "The name for one of the listed recommendation templates.
", "ListResiliencyPoliciesRequest$policyName": "The name of the policy
", "LogicalResourceId$resourceGroupName": "The name of the resource group that this resource belongs to.
", - "PhysicalResource$parentResourceName": "The name of the parent resource.
", + "PhysicalResource$parentResourceName": "Name of the parent resource.
", "PhysicalResource$resourceName": "The name of the resource.
", - "RecommendationTemplate$name": "The name for the recommendation template.
", + "RecommendationTemplate$name": "Name for the recommendation template.
", "ResiliencyPolicy$policyName": "The name of the policy
", "ResourceMapping$appRegistryAppName": "The name of the application this resource is mapped to.
", - "ResourceMapping$resourceGroupName": "The name of the resource group this resource is mapped to.
", - "ResourceMapping$resourceName": "The name of the resource this resource is mapped to.
", + "ResourceMapping$resourceGroupName": "Name of the resource group that the resource is mapped to.
", + "ResourceMapping$resourceName": "Name of the resource that the resource is mapped to.
", "StartAppAssessmentRequest$assessmentName": "The name for the assessment.
", - "UpdateAppVersionResourceRequest$resourceName": "The name of the resource.
", + "UpdateAppVersionResourceRequest$resourceName": "Name of the resource.
", "UpdateResiliencyPolicyRequest$policyName": "The name of the policy
" } }, @@ -871,45 +957,51 @@ "base": null, "refs": { "AddDraftAppVersionResourceMappingsResponse$appVersion": "The version of the application.
", - "AppAssessment$appVersion": "The version of the application.
", - "AppAssessmentSummary$appVersion": "The version of the application.
", - "AppVersionSummary$appVersion": "The version of the application.
", - "CreateAppVersionAppComponentResponse$appVersion": "The Resilience Hub application version.
", - "CreateAppVersionResourceResponse$appVersion": "The Resilience Hub application version.
", - "DeleteAppVersionAppComponentResponse$appVersion": "The Resilience Hub application version.
", - "DeleteAppVersionResourceResponse$appVersion": "The Resilience Hub application version.
", - "DescribeAppVersionAppComponentRequest$appVersion": "The Resilience Hub application version.
", - "DescribeAppVersionAppComponentResponse$appVersion": "The Resilience Hub application version.
", - "DescribeAppVersionRequest$appVersion": "The Resilience Hub application version.
", - "DescribeAppVersionResourceRequest$appVersion": "The Resilience Hub application version.
", - "DescribeAppVersionResourceResponse$appVersion": "The Resilience Hub application version.
", + "AppAssessment$appVersion": "Version of an application.
", + "AppAssessment$versionName": "Version name of the published application.
", + "AppAssessmentSummary$appVersion": "Version of an application.
", + "AppAssessmentSummary$versionName": "Name of an application version.
", + "AppVersionSummary$appVersion": "Version of an application.
", + "AppVersionSummary$versionName": "Name of the application version.
", + "CreateAppVersionAppComponentResponse$appVersion": "Resilience Hub application version.
", + "CreateAppVersionResourceResponse$appVersion": "Resilience Hub application version.
", + "DeleteAppVersionAppComponentResponse$appVersion": "Resilience Hub application version.
", + "DeleteAppVersionResourceResponse$appVersion": "Resilience Hub application version.
", + "DescribeAppVersionAppComponentRequest$appVersion": "Resilience Hub application version.
", + "DescribeAppVersionAppComponentResponse$appVersion": "Resilience Hub application version.
", + "DescribeAppVersionRequest$appVersion": "Resilience Hub application version.
", + "DescribeAppVersionResourceRequest$appVersion": "Resilience Hub application version.
", + "DescribeAppVersionResourceResponse$appVersion": "Resilience Hub application version.
", "DescribeAppVersionResourcesResolutionStatusRequest$appVersion": "The version of the application.
", "DescribeAppVersionResourcesResolutionStatusResponse$appVersion": "The version of the application.
", - "DescribeAppVersionResponse$appVersion": "The Resilience Hub application version.
", + "DescribeAppVersionResponse$appVersion": "Resilience Hub application version.
", "DescribeAppVersionTemplateRequest$appVersion": "The version of the application.
", "DescribeAppVersionTemplateResponse$appVersion": "The version of the application.
", "DescribeDraftAppVersionResourcesImportStatusResponse$appVersion": "The version of the application.
", "ImportResourcesToDraftAppVersionResponse$appVersion": "The version of the application.
", - "ListAppInputSourcesRequest$appVersion": "The Resilience Hub application version.
", - "ListAppVersionAppComponentsRequest$appVersion": "The version of the Application Component.
", - "ListAppVersionAppComponentsResponse$appVersion": "The Resilience Hub application version.
", + "ListAppInputSourcesRequest$appVersion": "Resilience Hub application version.
", + "ListAppVersionAppComponentsRequest$appVersion": "Version of the Application Component.
", + "ListAppVersionAppComponentsResponse$appVersion": "Resilience Hub application version.
", "ListAppVersionResourceMappingsRequest$appVersion": "The version of the application.
", "ListAppVersionResourcesRequest$appVersion": "The version of the application.
", "ListUnsupportedAppVersionResourcesRequest$appVersion": "The version of the application.
", + "PublishAppVersionRequest$versionName": "Name of the application version.
", "PublishAppVersionResponse$appVersion": "The version of the application.
", + "PublishAppVersionResponse$versionName": "Name of the application version.
", "PutDraftAppVersionTemplateResponse$appVersion": "The version of the application.
", "RemoveDraftAppVersionResourceMappingsResponse$appVersion": "The version of the application.
", "ResolveAppVersionResourcesRequest$appVersion": "The version of the application.
", "ResolveAppVersionResourcesResponse$appVersion": "The version of the application.
", "StartAppAssessmentRequest$appVersion": "The version of the application.
", - "UpdateAppVersionAppComponentResponse$appVersion": "The Resilience Hub application version.
", - "UpdateAppVersionResourceResponse$appVersion": "The Resilience Hub application version.
", - "UpdateAppVersionResponse$appVersion": "The Resilience Hub application version.
" + "UpdateAppVersionAppComponentResponse$appVersion": "Resilience Hub application version.
", + "UpdateAppVersionResourceResponse$appVersion": "Resilience Hub application version.
", + "UpdateAppVersionResponse$appVersion": "Resilience Hub application version.
" } }, "ErrorMessage": { "base": null, "refs": { + "BatchUpdateRecommendationStatusFailedEntry$errorMessage": "Indicates the error that occurred while excluding an operational recommendation.
", "ResourceError$reason": "This is the error message.
" } }, @@ -919,6 +1011,34 @@ "ResiliencyPolicy$estimatedCostTier": "Specifies the estimated cost tier of the resiliency policy.
" } }, + "EventSubscription": { + "base": "Indicates an event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.
", + "refs": { + "EventSubscriptionList$member": null + } + }, + "EventSubscriptionList": { + "base": null, + "refs": { + "App$eventSubscriptions": "The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.
", + "CreateAppRequest$eventSubscriptions": "The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification.
", + "UpdateAppRequest$eventSubscriptions": "The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.
" + } + }, + "EventType": { + "base": null, + "refs": { + "EventSubscription$eventType": "The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected (DriftDetected) and Scheduled assessment failure (ScheduledAssessmentFailure) events.
Indicates the reason for excluding an operational recommendation.
", + "RecommendationItem$excludeReason": "Indicates the reason for excluding an operational recommendation.
", + "UpdateRecommendationStatusRequestEntry$excludeReason": "Indicates the reason for excluding an operational recommendation.
" + } + }, "FailurePolicy": { "base": "Defines a failure policy.
", "refs": { @@ -931,6 +1051,24 @@ "ConfigRecommendation$haArchitecture": "The architecture type.
" } }, + "IamRoleArn": { + "base": null, + "refs": { + "IamRoleArnList$member": null + } + }, + "IamRoleArnList": { + "base": null, + "refs": { + "PermissionModel$crossAccountRoleArns": "Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.
These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.
These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the primary account.
Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.
You must have iam:passRole permission for this role while creating or updating the application.
Defines a logical resource identifier.
", "refs": { - "CreateAppVersionResourceRequest$logicalResourceId": "The logical identifier of the resource.
", - "DeleteAppVersionResourceRequest$logicalResourceId": "The logical identifier of the resource.
", - "DescribeAppVersionResourceRequest$logicalResourceId": "The logical identifier of the resource.
", - "PhysicalResource$logicalResourceId": "The logical identifier of the resource.
", - "UnsupportedResource$logicalResourceId": "The logical resource identifier for the unsupported resource.
", - "UpdateAppVersionResourceRequest$logicalResourceId": "The logical identifier of the resource.
" + "CreateAppVersionResourceRequest$logicalResourceId": "Logical identifier of the resource.
", + "DeleteAppVersionResourceRequest$logicalResourceId": "Logical identifier of the resource.
", + "DescribeAppVersionResourceRequest$logicalResourceId": "Logical identifier of the resource.
", + "PhysicalResource$logicalResourceId": "Logical identifier of the resource.
", + "UnsupportedResource$logicalResourceId": "Logical resource identifier for the unsupported resource.
", + "UpdateAppVersionResourceRequest$logicalResourceId": "Logical identifier of the resource.
" + } + }, + "LongOptional": { + "base": null, + "refs": { + "AppVersionSummary$identifier": "Identifier of the application version.
", + "PublishAppVersionResponse$identifier": "Identifier of the application version.
" } }, "MaxResults": { "base": null, "refs": { - "ListAlarmRecommendationsRequest$maxResults": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Indicates the maximum number of applications requested.
", + "ListAppAssessmentsRequest$maxResults": "Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of input sources to be displayed per Resilience Hub application.
", "ListAppVersionAppComponentsRequest$maxResults": "Maximum number of Application Components to be displayed per Resilience Hub application version.
", - "ListAppVersionResourceMappingsRequest$maxResults": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Null, or the token from a previous call to get the next set of results.
", - "ListAlarmRecommendationsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAlarmRecommendationsResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", + "ListAppAssessmentComplianceDriftsRequest$nextToken": "Indicates the unique token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
", + "ListAppAssessmentComplianceDriftsResponse$nextToken": "Token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
", "ListAppAssessmentsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListAppAssessmentsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppAssessmentsResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListAppComponentCompliancesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListAppComponentCompliancesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppComponentCompliancesResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListAppComponentRecommendationsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListAppComponentRecommendationsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppComponentRecommendationsResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListAppInputSourcesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListAppInputSourcesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppInputSourcesResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListAppVersionAppComponentsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListAppVersionAppComponentsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppVersionAppComponentsResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListAppVersionResourceMappingsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListAppVersionResourceMappingsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppVersionResourceMappingsResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListAppVersionResourcesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListAppVersionResourcesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppVersionResourcesResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListAppVersionsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListAppVersionsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppVersionsResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListAppsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListAppsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppsResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListRecommendationTemplatesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListRecommendationTemplatesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListRecommendationTemplatesResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListResiliencyPoliciesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListResiliencyPoliciesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListResiliencyPoliciesResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListSopRecommendationsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListSopRecommendationsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListSopRecommendationsResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListSuggestedResiliencyPoliciesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListSuggestedResiliencyPoliciesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListSuggestedResiliencyPoliciesResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListTestRecommendationsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListTestRecommendationsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListTestRecommendationsResponse$nextToken": "Token for the next set of results, or null if there are no more results.
", "ListUnsupportedAppVersionResourcesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", - "ListUnsupportedAppVersionResourcesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
" + "ListUnsupportedAppVersionResourcesResponse$nextToken": "Token for the next set of results, or null if there are no more results.
" + } + }, + "PermissionModel": { + "base": "Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.
", + "refs": { + "App$permissionModel": "Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.
", + "CreateAppRequest$permissionModel": "Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.
", + "UpdateAppRequest$permissionModel": "Defines the roles and credentials that Resilience Hub would use while creating an application, importing its resources, and running an assessment.
" + } + }, + "PermissionModelType": { + "base": null, + "refs": { + "PermissionModel$type": "Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user.
" } }, "PhysicalIdentifierType": { "base": null, "refs": { - "PhysicalResourceId$type": "Specifies the type of physical resource identifier.
The resource identifier is an Amazon Resource Name (ARN) .
The resource identifier is an Resilience Hub-native identifier.
Specifies the type of physical resource identifier.
The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:
AWS::ECS::Service
AWS::EFS::FileSystem
AWS::ElasticLoadBalancingV2::LoadBalancer
AWS::Lambda::Function
AWS::SNS::Topic
The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:
AWS::ApiGateway::RestApi
AWS::ApiGatewayV2::Api
AWS::AutoScaling::AutoScalingGroup
AWS::DocDB::DBCluster
AWS::DocDB::DBGlobalCluster
AWS::DocDB::DBInstance
AWS::DynamoDB::GlobalTable
AWS::DynamoDB::Table
AWS::EC2::EC2Fleet
AWS::EC2::Instance
AWS::EC2::NatGateway
AWS::EC2::Volume
AWS::ElasticLoadBalancing::LoadBalancer
AWS::RDS::DBCluster
AWS::RDS::DBInstance
AWS::RDS::GlobalCluster
AWS::Route53::RecordSet
AWS::S3::Bucket
AWS::SQS::Queue
Defines a physical resource identifier.
", "refs": { - "PhysicalResource$physicalResourceId": "The physical identifier of the resource.
", - "ResourceMapping$physicalResourceId": "The identifier of this resource.
", - "UnsupportedResource$physicalResourceId": "The physical resource identifier for the unsupported resource.
" + "PhysicalResource$physicalResourceId": "Identifier of the physical resource.
", + "ResourceMapping$physicalResourceId": "Identifier of the physical resource.
", + "UnsupportedResource$physicalResourceId": "Physical resource identifier for the unsupported resource.
" } }, "PhysicalResourceList": { @@ -1250,7 +1422,7 @@ "RecommendationComplianceStatus": { "base": null, "refs": { - "ComponentRecommendation$recommendationStatus": "The recommendation status.
" + "ComponentRecommendation$recommendationStatus": "Status of the recommendation.
" } }, "RecommendationDisruptionCompliance": { @@ -1275,7 +1447,7 @@ "RecommendationItemList": { "base": null, "refs": { - "AlarmRecommendation$items": "The list of CloudWatch alarm recommendations.
", + "AlarmRecommendation$items": "List of CloudWatch alarm recommendations.
", "SopRecommendation$items": "The recommendation items.
", "TestRecommendation$items": "The test recommendation items.
" } @@ -1296,15 +1468,15 @@ "RecommendationTemplateStatus": { "base": null, "refs": { - "DeleteRecommendationTemplateResponse$status": "The status of the action.
", - "RecommendationTemplate$status": "The status of the action.
", + "DeleteRecommendationTemplateResponse$status": "Status of the action.
", + "RecommendationTemplate$status": "Status of the action.
", "RecommendationTemplateStatusList$member": null } }, "RecommendationTemplateStatusList": { "base": null, "refs": { - "ListRecommendationTemplatesRequest$status": "The status of the action.
" + "ListRecommendationTemplatesRequest$status": "Status of the action.
" } }, "RemoveDraftAppVersionResourceMappingsRequest": { @@ -1340,7 +1512,7 @@ "ResiliencyPolicy": { "base": "Defines a resiliency policy.
", "refs": { - "AppAssessment$policy": "The resiliency policy.
", + "AppAssessment$policy": "Resiliency policy of an application.
", "CreateResiliencyPolicyResponse$policy": "The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
", "DescribeResiliencyPolicyResponse$policy": "Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.
", "ResiliencyPolicies$member": null, @@ -1358,7 +1530,7 @@ "ResiliencyScore": { "base": "The overall resiliency score, returned as an object that includes the disruption score and outage score.
", "refs": { - "AppAssessment$resiliencyScore": "The current resiliency score for the application.
", + "AppAssessment$resiliencyScore": "Current resiliency score for an application.
", "AppComponentCompliance$resiliencyScore": "The current resiliency score for the application.
" } }, @@ -1400,8 +1572,8 @@ "ResourceImportStatusType": { "base": null, "refs": { - "DescribeDraftAppVersionResourcesImportStatusResponse$status": "The status of the action.
", - "ImportResourcesToDraftAppVersionResponse$status": "The status of the action.
" + "DescribeDraftAppVersionResourcesImportStatusResponse$status": "Status of the action.
", + "ImportResourcesToDraftAppVersionResponse$status": "Status of the action.
" } }, "ResourceImportStrategyType": { @@ -1420,7 +1592,7 @@ "base": null, "refs": { "AddDraftAppVersionResourceMappingsRequest$resourceMappings": "Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
List of sources that are used to map a logical resource from the template to a physical resource. You can use sources such as CloudFormation, Terraform state files, AppRegistry applications, or Amazon EKS.
", "ListAppVersionResourceMappingsResponse$resourceMappings": "Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
The status of the action.
", - "ResolveAppVersionResourcesResponse$status": "The status of the action.
" + "DescribeAppVersionResourcesResolutionStatusResponse$status": "Status of the action.
", + "ResolveAppVersionResourcesResponse$status": "Status of the action.
" } }, "ResourceSourceType": { "base": null, "refs": { - "PhysicalResource$sourceType": "The type of input source.
" + "PhysicalResource$sourceType": "Type of input source.
" } }, "ResourceType": { @@ -1513,10 +1685,12 @@ "SpecReferenceId": { "base": null, "refs": { - "AlarmRecommendation$referenceId": "The reference identifier of the alarm recommendation.
", - "ConfigRecommendation$referenceId": "The reference identifier for the recommendation configuration.
", - "SopRecommendation$referenceId": "The reference identifier for the SOP recommendation.
", - "TestRecommendation$referenceId": "The reference identifier for the test recommendation.
" + "AlarmRecommendation$referenceId": "Reference identifier of the alarm recommendation.
", + "BatchUpdateRecommendationStatusSuccessfulEntry$referenceId": "Reference identifier of the operational recommendation.
", + "ConfigRecommendation$referenceId": "Reference identifier for the recommendation configuration.
", + "SopRecommendation$referenceId": "Reference identifier for the SOP recommendation.
", + "TestRecommendation$referenceId": "Reference identifier for the test recommendation.
", + "UpdateRecommendationStatusRequestEntry$referenceId": "Reference identifier of the operational recommendation item.
" } }, "StartAppAssessmentRequest": { @@ -1544,51 +1718,61 @@ "String2048": { "base": null, "refs": { - "CreateAppVersionResourceRequest$physicalResourceId": "The physical identifier of the resource.
", - "DeleteAppVersionResourceRequest$physicalResourceId": "The physical identifier of the resource.
", - "DescribeAppVersionResourceRequest$physicalResourceId": "The physical identifier of the resource.
", - "UpdateAppVersionResourceRequest$physicalResourceId": "The physical identifier of the resource.
" + "CreateAppVersionResourceRequest$physicalResourceId": "Physical identifier of the resource.
", + "DeleteAppVersionResourceRequest$physicalResourceId": "Physical identifier of the resource.
", + "DescribeAppVersionResourceRequest$physicalResourceId": "Physical identifier of the resource.
", + "UpdateAppVersionResourceRequest$physicalResourceId": "Physical identifier of the resource.
" } }, "String255": { "base": null, "refs": { - "AppComponent$id": "Unique identifier of the Application Component.
", - "AppComponent$name": "The name of the Application Component.
", + "AppComponent$id": "Identifier of the Application Component.
", + "AppComponent$name": "Name of the Application Component.
", "AppComponent$type": "The type of Application Component.
", "AppComponentNameList$member": null, "AppInputSource$sourceName": "The name of the input source.
", - "CreateAppVersionAppComponentRequest$id": "The identifier of the Application Component.
", - "CreateAppVersionAppComponentRequest$name": "The name of the Application Component.
", - "CreateAppVersionAppComponentRequest$type": "The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
", - "CreateAppVersionResourceRequest$resourceType": "The type of resource.
", - "DeleteAppVersionAppComponentRequest$id": "The identifier of the Application Component.
", - "DescribeAppVersionAppComponentRequest$id": "The identifier of the Application Component.
", + "BatchUpdateRecommendationStatusFailedEntry$entryId": "An identifier of an entry in this batch that is used to communicate the result.
The entryIds of a batch request need to be unique within a request.
An identifier for an entry in this batch that is used to communicate the result.
The entryIds of a batch request need to be unique within a request.
Assessment identifier that is associated with this drift item.
", + "ComplianceDrift$appId": "Identifier of your application.
", + "ComplianceDrift$appVersion": "Published version of your application on which drift was detected.
", + "ComplianceDrift$entityId": "Identifier of an entity in which drift was detected. For compliance drift, the entity ID can be either application ID or the AppComponent ID.
", + "ComplianceDrift$entityType": "The type of entity in which drift was detected. For compliance drifts, Resilience Hub supports AWS::ResilienceHub::AppComponent and AWS::ResilienceHub::Application.
Assessment identifier of a previous assessment of the same application version. Resilience Hub uses the previous assessment (associated with the reference identifier) to compare the compliance with the current assessment to identify drifts.
", + "CreateAppVersionAppComponentRequest$id": "Identifier of the Application Component.
", + "CreateAppVersionAppComponentRequest$name": "Name of the Application Component.
", + "CreateAppVersionAppComponentRequest$type": "Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
", + "CreateAppVersionResourceRequest$resourceType": "Type of resource.
", + "DeleteAppVersionAppComponentRequest$id": "Identifier of the Application Component.
", + "DescribeAppVersionAppComponentRequest$id": "Identifier of the Application Component.
", "DescribeAppVersionResourcesResolutionStatusRequest$resolutionId": "The identifier for a specific resolution.
", "DescribeAppVersionResourcesResolutionStatusResponse$resolutionId": "The identifier for a specific resolution.
", + "EventSubscription$name": "Unique name to identify an event subscription.
", "ListAppVersionResourcesRequest$resolutionId": "The identifier for a specific resolution.
", "ListAppVersionResourcesResponse$resolutionId": "The ID for a specific resolution.
", "ListUnsupportedAppVersionResourcesRequest$resolutionId": "The identifier for a specific resolution.
", "ListUnsupportedAppVersionResourcesResponse$resolutionId": "The identifier for a specific resolution.
", - "LogicalResourceId$eksSourceName": "The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
The identifier of the resource.
", + "LogicalResourceId$eksSourceName": "Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Identifier of the resource.
", "LogicalResourceId$logicalStackName": "The name of the CloudFormation stack this resource belongs to.
", "LogicalResourceId$terraformSourceName": "The name of the Terraform S3 state file this resource belongs to.
", "PhysicalResource$resourceType": "The type of resource.
", - "PhysicalResourceId$identifier": "The identifier of the physical resource.
", + "PhysicalResourceId$identifier": "Identifier of the physical resource.
", "ResolveAppVersionResourcesResponse$resolutionId": "The identifier for a specific resolution.
", - "ResourceError$logicalResourceId": "This is the identifier of the resource.
", - "ResourceError$physicalResourceId": "This is the identifier of the physical resource.
", - "ResourceMapping$eksSourceName": "The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
Identifier of the logical resource.
", + "ResourceError$physicalResourceId": "Identifier of the physical resource.
", + "ResourceMapping$eksSourceName": "Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in \"eks-cluster/namespace\" format.
The name of the CloudFormation stack this resource is mapped to.
", "ResourceMapping$terraformSourceName": "The short name of the Terraform source.
", "String255List$member": null, "UnsupportedResource$resourceType": "The type of resource.
", "UnsupportedResource$unsupportedResourceStatus": "The status of the unsupported resource.
", - "UpdateAppVersionAppComponentRequest$id": "The identifier of the Application Component.
", - "UpdateAppVersionAppComponentRequest$name": "The name of the Application Component.
", - "UpdateAppVersionAppComponentRequest$type": "The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
", - "UpdateAppVersionResourceRequest$resourceType": "The type of resource.
" + "UpdateAppVersionAppComponentRequest$id": "Identifier of the Application Component.
", + "UpdateAppVersionAppComponentRequest$name": "Name of the Application Component.
", + "UpdateAppVersionAppComponentRequest$type": "Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
", + "UpdateAppVersionResourceRequest$resourceType": "Type of resource.
", + "UpdateRecommendationStatusRequestEntry$entryId": "An identifier for an entry in this batch that is used to communicate the result.
The entryIds of a batch request need to be unique within a request.
The name of the alarm recommendation.
", + "AlarmRecommendation$name": "Name of the alarm recommendation.
", "AlarmRecommendation$prerequisite": "The prerequisite for the alarm recommendation.
", "AlarmReferenceIdList$member": null, "AppAssessment$message": "Error or warning message from the assessment execution
", - "AppAssessmentSummary$message": "The message from the assessment run.
", + "AppAssessmentSummary$message": "Message from the assessment run.
", "AppComponentCompliance$message": "The compliance message.
", "ConflictException$message": null, "DescribeAppVersionResourcesResolutionStatusResponse$errorMessage": "The returned error message for the request.
", "DescribeDraftAppVersionResourcesImportStatusResponse$errorMessage": "The returned error message for the request.
", "DisruptionCompliance$message": "The disruption compliance message.
", "DisruptionCompliance$rpoDescription": "The RPO description.
", - "DisruptionCompliance$rpoReferenceId": "The RPO reference identifier.
", + "DisruptionCompliance$rpoReferenceId": "Reference identifier of the RPO .
", "DisruptionCompliance$rtoDescription": "The RTO description.
", - "DisruptionCompliance$rtoReferenceId": "The RTO reference identifier.
", + "DisruptionCompliance$rtoReferenceId": "Reference identifier of the RTO.
", "InternalServerException$message": null, "RecommendationDisruptionCompliance$expectedRpoDescription": "The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.
", "RecommendationDisruptionCompliance$expectedRtoDescription": "The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.
", - "RecommendationItem$resourceId": "The resource identifier.
", - "RecommendationTemplate$message": "The message for the recommendation template.
", + "RecommendationItem$resourceId": "Identifier of the resource.
", + "RecommendationTemplate$message": "Message for the recommendation template.
", "ResourceNotFoundException$message": null, "S3Location$bucket": "The name of the Amazon S3 bucket.
", "S3Location$prefix": "The prefix for the Amazon S3 bucket.
", "ServiceQuotaExceededException$message": null, - "SopRecommendation$description": "The description of the SOP recommendation.
", - "SopRecommendation$prerequisite": "The prerequisite for the SOP recommendation.
", - "TestRecommendation$description": "The description for the test recommendation.
", - "TestRecommendation$prerequisite": "The prerequisite of the test recommendation.
", + "SopRecommendation$description": "Description of the SOP recommendation.
", + "SopRecommendation$prerequisite": "Prerequisite for the SOP recommendation.
", + "TestRecommendation$description": "Description for the test recommendation.
", + "TestRecommendation$prerequisite": "Prerequisite of the test recommendation.
", "ThrottlingException$message": null, + "UpdateRecommendationStatusItem$resourceId": "Resource identifier of the operational recommendation item.
", "ValidationException$message": null } }, @@ -1656,15 +1841,15 @@ "TagMap": { "base": null, "refs": { - "App$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", - "AppAssessment$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", - "CreateAppRequest$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", - "CreateRecommendationTemplateRequest$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", - "CreateResiliencyPolicyRequest$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", - "ListTagsForResourceResponse$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", - "RecommendationTemplate$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", - "ResiliencyPolicy$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", - "StartAppAssessmentRequest$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "App$tags": "Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "AppAssessment$tags": "Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "CreateAppRequest$tags": "Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "CreateRecommendationTemplateRequest$tags": "Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "CreateResiliencyPolicyRequest$tags": "Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "ListTagsForResourceResponse$tags": "Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "RecommendationTemplate$tags": "Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "ResiliencyPolicy$tags": "Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "StartAppAssessmentRequest$tags": "Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", "TagResourceRequest$tags": "The tags to assign to the resource. Each tag consists of a key/value pair.
" } }, @@ -1688,7 +1873,7 @@ "base": null, "refs": { "CreateRecommendationTemplateRequest$format": "The format for the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
The format of the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
Format of the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
The level of risk for this test recommendation.
" + "TestRecommendation$risk": "Level of risk for this test recommendation.
" } }, "TestType": { "base": null, "refs": { - "TestRecommendation$type": "The type of test recommendation.
" + "TestRecommendation$type": "Type of test recommendation.
" } }, "ThrottlingException": { @@ -1738,15 +1923,19 @@ "TimeStamp": { "base": null, "refs": { - "App$creationTime": "The timestamp for when the app was created.
", - "App$lastAppComplianceEvaluationTime": "The timestamp for the most recent compliance evaluation.
", - "App$lastResiliencyScoreEvaluationTime": "The timestamp for the most recent resiliency score evaluation.
", - "AppAssessment$endTime": "The end time for the action.
", - "AppAssessment$startTime": "The starting time for the action.
", - "AppAssessmentSummary$endTime": "The end time for the action.
", - "AppAssessmentSummary$startTime": "The starting time for the action.
", + "App$creationTime": "Timestamp for when the app was created.
", + "App$lastAppComplianceEvaluationTime": "Timestamp for the most recent compliance evaluation.
", + "App$lastDriftEvaluationTime": "Indicates the last time that a drift was evaluated.
", + "App$lastResiliencyScoreEvaluationTime": "Timestamp for the most recent resiliency score evaluation.
", + "AppAssessment$endTime": "End time for the action.
", + "AppAssessment$startTime": "Starting time for the action.
", + "AppAssessmentSummary$endTime": "End time for the action.
", + "AppAssessmentSummary$startTime": "Starting time for the action.
", "AppSummary$creationTime": "The timestamp for when the app was created.
", + "AppVersionSummary$creationTime": "Creation time of the application version.
", "DescribeDraftAppVersionResourcesImportStatusResponse$statusChangeTime": "The timestamp for when the status last changed.
", + "ListAppVersionsRequest$endTime": "Upper limit of the time range to filter the application versions.
", + "ListAppVersionsRequest$startTime": "Lower limit of the time range to filter the application versions.
", "RecommendationTemplate$endTime": "The end time for the action.
", "RecommendationTemplate$startTime": "The start time for the action.
", "ResiliencyPolicy$creationTime": "The timestamp for when the resiliency policy was created.
" @@ -1814,6 +2003,25 @@ "refs": { } }, + "UpdateRecommendationStatusItem": { + "base": "Defines the operational recommendation item that needs a status update.
", + "refs": { + "BatchUpdateRecommendationStatusSuccessfulEntry$item": "The operational recommendation item.
", + "UpdateRecommendationStatusRequestEntry$item": "The operational recommendation item.
" + } + }, + "UpdateRecommendationStatusRequestEntries": { + "base": null, + "refs": { + "BatchUpdateRecommendationStatusRequest$requestEntries": "Defines the list of operational recommendations that need to be included or excluded.
" + } + }, + "UpdateRecommendationStatusRequestEntry": { + "base": "Defines the operational recommendation item that is to be included or excluded.
", + "refs": { + "UpdateRecommendationStatusRequestEntries$member": null + } + }, "UpdateResiliencyPolicyRequest": { "base": null, "refs": { @@ -1827,7 +2035,7 @@ "Uuid": { "base": null, "refs": { - "AlarmRecommendation$recommendationId": "The identifier of the alarm recommendation.
", + "AlarmRecommendation$recommendationId": "Identifier of the alarm recommendation.
", "RecommendationIdList$member": null, "SopRecommendation$recommendationId": "Identifier for the SOP recommendation.
", "TestRecommendation$recommendationId": "Identifier for the test recommendation.
" diff --git a/src/data/resiliencehub/2020-04-30/docs-2.json.php b/src/data/resiliencehub/2020-04-30/docs-2.json.php index e2c22bb9d1..aeb13bd1cb 100644 --- a/src/data/resiliencehub/2020-04-30/docs-2.json.php +++ b/src/data/resiliencehub/2020-04-30/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. It offers continual resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production.
', 'operations' => [ 'AddDraftAppVersionResourceMappings' => 'Adds the resource mapping for the draft application version. You can also update an existing resource mapping to a new physical resource.
', 'CreateApp' => 'Creates an Resilience Hub application. An Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe an Resilience Hub application, you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. For more information about the number of resources supported per application, see Service Quotas.
After you create an Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).
', 'CreateAppVersionAppComponent' => 'Creates a new Application Component in the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Adds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must call ResolveAppVersionResources API.
Creates a new recommendation template for the Resilience Hub application.
', 'CreateResiliencyPolicy' => 'Creates a resiliency policy for an application.
', 'DeleteApp' => 'Deletes an Resilience Hub application. This is a destructive action that can\'t be undone.
', 'DeleteAppAssessment' => 'Deletes an Resilience Hub application assessment. This is a destructive action that can\'t be undone.
', 'DeleteAppInputSource' => 'Deletes the input source and all of its imported resources from the Resilience Hub application.
', 'DeleteAppVersionAppComponent' => 'Deletes an Application Component from the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
You will not be able to delete an Application Component if it has resources associated with it.
Deletes a resource from the Resilience Hub application.
You can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Deletes a recommendation template. This is a destructive action that can\'t be undone.
', 'DeleteResiliencyPolicy' => 'Deletes a resiliency policy. This is a destructive action that can\'t be undone.
', 'DescribeApp' => 'Describes an Resilience Hub application.
', 'DescribeAppAssessment' => 'Describes an assessment for an Resilience Hub application.
', 'DescribeAppVersion' => 'Describes the Resilience Hub application version.
', 'DescribeAppVersionAppComponent' => 'Describes an Application Component in the Resilience Hub application.
', 'DescribeAppVersionResource' => 'Describes a resource of the Resilience Hub application.
This API accepts only one of the following parameters to descibe the resource:
resourceName
logicalResourceId
physicalResourceId (Along with physicalResourceId, you can also provide awsAccountId, and awsRegion)
Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.
Describes details about an Resilience Hub application.
', 'DescribeDraftAppVersionResourcesImportStatus' => 'Describes the status of importing resources to an application version.
If you get a 404 error with ResourceImportStatusNotFoundAppMetadataException, you must call importResourcesToDraftAppVersion after creating the application and before calling describeDraftAppVersionResourcesImportStatus to obtain the status.
Describes a specified resiliency policy for an Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.
', 'ImportResourcesToDraftAppVersion' => 'Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
', 'ListAlarmRecommendations' => 'Lists the alarm recommendations for an Resilience Hub application.
', 'ListAppAssessments' => 'Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.
', 'ListAppComponentCompliances' => 'Lists the compliances for an Resilience Hub Application Component.
', 'ListAppComponentRecommendations' => 'Lists the recommendations for an Resilience Hub Application Component.
', 'ListAppInputSources' => 'Lists all the input sources of the Resilience Hub application. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
', 'ListAppVersionAppComponents' => 'Lists all the Application Components in the Resilience Hub application.
', 'ListAppVersionResourceMappings' => 'Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.
', 'ListAppVersionResources' => 'Lists all the resources in an Resilience Hub application.
', 'ListAppVersions' => 'Lists the different versions for the Resilience Hub applications.
', 'ListApps' => 'Lists your Resilience Hub applications.
You can filter applications using only one filter at a time or without using any filter. If you try to filter applications using multiple filters, you will get the following error:
An error occurred (ValidationException) when calling the ListApps operation: Only one filter is supported for this operation.
Lists the recommendation templates for the Resilience Hub applications.
', 'ListResiliencyPolicies' => 'Lists the resiliency policies for the Resilience Hub applications.
', 'ListSopRecommendations' => 'Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
', 'ListSuggestedResiliencyPolicies' => 'Lists the suggested resiliency policies for the Resilience Hub applications.
', 'ListTagsForResource' => 'Lists the tags for your resources in your Resilience Hub applications.
', 'ListTestRecommendations' => 'Lists the test recommendations for the Resilience Hub application.
', 'ListUnsupportedAppVersionResources' => 'Lists the resources that are not currently supported in Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub.
', 'PublishAppVersion' => 'Publishes a new version of a specific Resilience Hub application.
', 'PutDraftAppVersionTemplate' => 'Adds or updates the app template for an Resilience Hub application draft version.
', 'RemoveDraftAppVersionResourceMappings' => 'Removes resource mappings from a draft application version.
', 'ResolveAppVersionResources' => 'Resolves the resources for an application version.
', 'StartAppAssessment' => 'Creates a new application assessment for an application.
', 'TagResource' => 'Applies one or more tags to a resource.
', 'UntagResource' => 'Removes one or more tags from a resource.
', 'UpdateApp' => 'Updates an application.
', 'UpdateAppVersion' => 'Updates the Resilience Hub application version.
This API updates the Resilience Hub application draft version. To use this information for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Updates an existing Application Component in the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Updates the resource details in the Resilience Hub application.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must call ResolveAppVersionResources API.
Updates a resiliency policy.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You don\'t have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.
', 'refs' => [], ], 'AddDraftAppVersionResourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddDraftAppVersionResourceMappingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdditionalInfoMap' => [ 'base' => NULL, 'refs' => [ 'AppComponent$additionalInfo' => 'Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
Currently, there is no supported additional information for Application Components.
', 'CreateAppVersionResourceRequest$additionalInfo' => 'Currently, there is no supported additional information for resources.
', 'DescribeAppVersionResponse$additionalInfo' => 'Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter supports only failover region and account.
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
Currently, there is no supported additional information for Application Components.
', 'UpdateAppVersionRequest$additionalInfo' => 'Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
Currently, there is no supported additional information for resources.
', 'UpdateAppVersionResponse$additionalInfo' => 'Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter supports only failover region and account.
Defines a recommendation for a CloudWatch alarm.
', 'refs' => [ 'AlarmRecommendationList$member' => NULL, ], ], 'AlarmRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ListAlarmRecommendationsResponse$alarmRecommendations' => 'The alarm recommendations for an Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.
', ], ], 'AlarmReferenceIdList' => [ 'base' => NULL, 'refs' => [ 'TestRecommendation$dependsOnAlarms' => 'A list of recommended alarms that are used in the test and must be exported before or with the test.
', ], ], 'AlarmType' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$type' => 'The type of alarm recommendation.
', ], ], 'App' => [ 'base' => 'Defines an Resilience Hub application.
', 'refs' => [ 'CreateAppResponse$app' => 'The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.
', 'DescribeAppResponse$app' => 'The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
', 'UpdateAppResponse$app' => 'The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
', ], ], 'AppAssessment' => [ 'base' => 'Defines an application assessment.
', 'refs' => [ 'DescribeAppAssessmentResponse$assessment' => 'The assessment for an Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.
', 'StartAppAssessmentResponse$assessment' => 'The assessment created.
', ], ], 'AppAssessmentScheduleType' => [ 'base' => NULL, 'refs' => [ 'App$assessmentSchedule' => 'Assessment execution schedule with \'Daily\' or \'Disabled\' values.
', 'AppSummary$assessmentSchedule' => 'Assessment execution schedule with \'Daily\' or \'Disabled\' values.
', 'CreateAppRequest$assessmentSchedule' => 'Assessment execution schedule with \'Daily\' or \'Disabled\' values.
', 'UpdateAppRequest$assessmentSchedule' => 'Assessment execution schedule with \'Daily\' or \'Disabled\' values.
', ], ], 'AppAssessmentSummary' => [ 'base' => 'Defines an application assessment summary.
', 'refs' => [ 'AppAssessmentSummaryList$member' => NULL, ], ], 'AppAssessmentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAppAssessmentsResponse$assessmentSummaries' => 'The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.
', ], ], 'AppComplianceStatusType' => [ 'base' => NULL, 'refs' => [ 'App$complianceStatus' => 'The current status of compliance for the resiliency policy.
', 'AppSummary$complianceStatus' => 'The current status of compliance for the resiliency policy.
', ], ], 'AppComponent' => [ 'base' => 'Defines an Application Component.
', 'refs' => [ 'AppComponentList$member' => NULL, 'CreateAppVersionAppComponentResponse$appComponent' => 'The list of Application Components that belong to this resource.
', 'DeleteAppVersionAppComponentResponse$appComponent' => 'The list of Application Components that belong to this resource.
', 'DescribeAppVersionAppComponentResponse$appComponent' => 'The list of Application Components that belong to this resource.
', 'UpdateAppVersionAppComponentResponse$appComponent' => 'The list of Application Components that belong to this resource.
', ], ], 'AppComponentCompliance' => [ 'base' => 'Defines the compliance of an Application Component against the resiliency policy.
', 'refs' => [ 'ComponentCompliancesList$member' => NULL, ], ], 'AppComponentList' => [ 'base' => NULL, 'refs' => [ 'ListAppVersionAppComponentsResponse$appComponents' => 'Defines an Application Component.
', 'PhysicalResource$appComponents' => 'The application components that belong to this resource.
', ], ], 'AppComponentNameList' => [ 'base' => NULL, 'refs' => [ 'CreateAppVersionResourceRequest$appComponents' => 'The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
', 'UpdateAppVersionResourceRequest$appComponents' => 'The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
', ], ], 'AppInputSource' => [ 'base' => 'The list of Resilience Hub application input sources.
', 'refs' => [ 'AppInputSourceList$member' => NULL, 'DeleteAppInputSourceResponse$appInputSource' => 'The name of the input source from where the application resource is imported from.
', ], ], 'AppInputSourceList' => [ 'base' => NULL, 'refs' => [ 'ListAppInputSourcesResponse$appInputSources' => 'The list of Resilience Hub application input sources.
', ], ], 'AppStatusType' => [ 'base' => NULL, 'refs' => [ 'App$status' => 'The status of the application.
', 'AppSummary$status' => 'The status of the application.
', ], ], 'AppSummary' => [ 'base' => 'Defines an application summary.
', 'refs' => [ 'AppSummaryList$member' => NULL, ], ], 'AppSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAppsResponse$appSummaries' => 'Summaries for the Resilience Hub application.
', ], ], 'AppTemplateBody' => [ 'base' => NULL, 'refs' => [ 'DescribeAppVersionTemplateResponse$appTemplateBody' => 'A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.
The appTemplateBody JSON string has the following structure:
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don\'t add the resources that you want to exclude.
Each resources array item includes the following fields:
logicalResourceId
The logical identifier of the resource.
Type: Object
Each logicalResourceId object includes the following fields:
identifier
The identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
type
The type of resource.
Type: string
name
The name of the resource.
Type: String
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
appComponents
The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each appComponents array item includes the following fields:
name
The name of the Application Component.
Type: String
type
The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don\'t add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
The logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
Each logicalResourceIds object includes the following fields:
identifier
The identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
version
The Resilience Hub application version.
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.
The appTemplateBody JSON string has the following structure:
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don\'t add the resources that you want to exclude.
Each resources array item includes the following fields:
logicalResourceId
The logical identifier of the resource.
Type: Object
Each logicalResourceId object includes the following fields:
identifier
The identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
type
The type of resource.
Type: string
name
The name of the resource.
Type: String
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
appComponents
The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each appComponents array item includes the following fields:
name
The name of the Application Component.
Type: String
type
The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don\'t add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
The logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
Each logicalResourceIds object includes the following fields:
identifier
The identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
version
The Resilience Hub application version.
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
The version of the application.
', ], ], 'AppVersionSummary' => [ 'base' => 'The version of the application.
', 'refs' => [ 'AppVersionList$member' => NULL, ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AddDraftAppVersionResourceMappingsRequest$appArn' => 'The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
', 'AppSummary$appArn' => 'The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the imported resource you want to remove from the Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
', 'DeleteAppInputSourceResponse$appArn' => 'The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for a recommendation template.
', 'DeleteRecommendationTemplateResponse$recommendationTemplateArn' => 'The Amazon Resource Name (ARN) for a recommendation template.
', 'DeleteResiliencyPolicyRequest$policyArn' => 'The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for a recommendation template.
', 'ListSopRecommendationsRequest$assessmentArn' => 'The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.
', 'ListTestRecommendationsRequest$assessmentArn' => 'The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for the recommendation template.
', 'RemoveDraftAppVersionResourceMappingsRequest$appArn' => 'The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resource.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'UpdateAppRequest$appArn' => 'The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Names (ARNs) for the resources.
', 'ImportResourcesToDraftAppVersionResponse$sourceArns' => 'The Amazon Resource Names (ARNs) for the resources you have imported.
', ], ], 'AssessmentCompliance' => [ 'base' => NULL, 'refs' => [ 'AppAssessment$compliance' => 'The application compliance against the resiliency policy.
', 'AppComponentCompliance$compliance' => 'The compliance of the Application Component against the resiliency policy.
', 'ConfigRecommendation$compliance' => 'The current compliance against the resiliency policy before applying the configuration change.
', ], ], 'AssessmentInvoker' => [ 'base' => NULL, 'refs' => [ 'AppAssessment$invoker' => 'The entity that invoked the assessment.
', 'AppAssessmentSummary$invoker' => 'The entity that invoked the assessment.
', 'ListAppAssessmentsRequest$invoker' => 'Specifies the entity that invoked a specific assessment, either a User or the System.
The current status of the assessment for the resiliency policy.
', 'AppAssessmentSummary$assessmentStatus' => 'The current status of the assessment for the resiliency policy.
', 'AssessmentStatusList$member' => NULL, 'DeleteAppAssessmentResponse$assessmentStatus' => 'The current status of the assessment for the resiliency policy.
', ], ], 'AssessmentStatusList' => [ 'base' => NULL, 'refs' => [ 'ListAppAssessmentsRequest$assessmentStatus' => 'The current status of the assessment for the resiliency policy.
', ], ], 'AwsRegion' => [ 'base' => NULL, 'refs' => [ 'CreateAppVersionResourceRequest$awsRegion' => 'The Amazon Web Services region that owns the physical resource.
', 'DeleteAppVersionResourceRequest$awsRegion' => 'The Amazon Web Services region that owns the physical resource.
', 'DescribeAppVersionResourceRequest$awsRegion' => 'The Amazon Web Services region that owns the physical resource.
', 'PhysicalResourceId$awsRegion' => 'The Amazon Web Services Region that the physical resource is located in.
', 'RecommendationItem$targetRegion' => 'The target region.
', 'UpdateAppVersionResourceRequest$awsRegion' => 'The Amazon Web Services region that owns the physical resource.
', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'DeleteAppRequest$forceDelete' => 'A boolean option to force the deletion of an Resilience Hub application.
', 'ListAppAssessmentsRequest$reverseOrder' => 'The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.
The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.
Indicates if a resource is included or excluded from the assessment.
', 'RecommendationItem$alreadyImplemented' => 'Specifies if the recommendation has already been implemented.
', 'RecommendationTemplate$needsReplacements' => 'Indicates if replacements are needed.
', 'ResourceErrorsDetails$hasMoreErrors' => 'This indicates if there are more errors not listed in the resourceErrors list.
', 'UpdateAppRequest$clearResiliencyPolicyArn' => 'Specifies if the resiliency policy ARN should be cleared.
', 'UpdateAppVersionResourceRequest$excluded' => 'Indicates if a resource is excluded from an Resilience Hub application.
You can exclude only imported resources from an Resilience Hub application.
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'CreateAppVersionAppComponentRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'CreateAppVersionResourceRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'CreateRecommendationTemplateRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'CreateResiliencyPolicyRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppAssessmentRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppInputSourceRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppVersionAppComponentRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppVersionResourceRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteRecommendationTemplateRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteResiliencyPolicyRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'StartAppAssessmentRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', ], ], 'ComplianceStatus' => [ 'base' => NULL, 'refs' => [ 'AppAssessment$complianceStatus' => 'The current status of the compliance for the resiliency policy.
', 'AppAssessmentSummary$complianceStatus' => 'The current status of compliance for the resiliency policy.
', 'AppComponentCompliance$status' => 'The status of the action.
', 'DisruptionCompliance$complianceStatus' => 'The current status of compliance for the resiliency policy.
', 'ListAppAssessmentsRequest$complianceStatus' => 'The current status of compliance for the resiliency policy.
', 'RecommendationDisruptionCompliance$expectedComplianceStatus' => 'The expected compliance status after applying the recommended configuration change.
', ], ], 'ComponentCompliancesList' => [ 'base' => NULL, 'refs' => [ 'ListAppComponentCompliancesResponse$componentCompliances' => 'The compliances for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and more.
', ], ], 'ComponentRecommendation' => [ 'base' => 'Defines recommendations for an Resilience Hub Application Component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.
', 'refs' => [ 'ComponentRecommendationList$member' => NULL, ], ], 'ComponentRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ListAppComponentRecommendationsResponse$componentRecommendations' => 'The recommendations for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, configuration recommendations, and recommendation statuses.
', ], ], 'ConfigRecommendation' => [ 'base' => 'Defines a configuration recommendation.
', 'refs' => [ 'ConfigRecommendationList$member' => NULL, ], ], 'ConfigRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ComponentRecommendation$configRecommendations' => 'The list of recommendations.
', ], ], 'ConfigRecommendationOptimizationType' => [ 'base' => NULL, 'refs' => [ 'ConfigRecommendation$optimizationType' => 'The type of optimization.
', ], ], 'ConflictException' => [ 'base' => 'This exception occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
', 'refs' => [], ], 'Cost' => [ 'base' => 'Defines a cost object.
', 'refs' => [ 'AppAssessment$cost' => 'The cost for the application.
', 'AppAssessmentSummary$cost' => 'The cost for the application.
', 'AppComponentCompliance$cost' => 'The cost for the application.
', 'ConfigRecommendation$cost' => 'The cost for the application.
', ], ], 'CostFrequency' => [ 'base' => NULL, 'refs' => [ 'Cost$frequency' => 'The cost frequency.
', ], ], 'CreateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppVersionAppComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppVersionAppComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppVersionResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppVersionResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecommendationTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecommendationTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResiliencyPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResiliencyPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'CurrencyCode' => [ 'base' => NULL, 'refs' => [ 'Cost$currency' => 'The cost currency, for example USD.
The Amazon Web Services account that owns the physical resource.
', 'DeleteAppVersionResourceRequest$awsAccountId' => 'The Amazon Web Services account that owns the physical resource.
', 'DescribeAppVersionResourceRequest$awsAccountId' => 'The Amazon Web Services account that owns the physical resource.
', 'PhysicalResourceId$awsAccountId' => 'The Amazon Web Services account that owns the physical resource.
', 'RecommendationItem$targetAccountId' => 'The target account identifier.
', 'UpdateAppVersionResourceRequest$awsAccountId' => 'The Amazon Web Services account that owns the physical resource.
', ], ], 'DataLocationConstraint' => [ 'base' => NULL, 'refs' => [ 'CreateResiliencyPolicyRequest$dataLocationConstraint' => 'Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
', 'ResiliencyPolicy$dataLocationConstraint' => 'Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
', 'UpdateResiliencyPolicyRequest$dataLocationConstraint' => 'Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
', ], ], 'DeleteAppAssessmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppAssessmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppInputSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppInputSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppVersionAppComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppVersionAppComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppVersionResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppVersionResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRecommendationTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRecommendationTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResiliencyPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResiliencyPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppAssessmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppAssessmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionAppComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionAppComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResourcesResolutionStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResourcesResolutionStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDraftAppVersionResourcesImportStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDraftAppVersionResourcesImportStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResiliencyPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResiliencyPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisruptionCompliance' => [ 'base' => 'Defines the compliance against the resiliency policy for a disruption.
', 'refs' => [ 'AssessmentCompliance$value' => NULL, ], ], 'DisruptionPolicy' => [ 'base' => NULL, 'refs' => [ 'CreateResiliencyPolicyRequest$policy' => 'The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
', 'ResiliencyPolicy$policy' => 'The resiliency policy.
', 'UpdateResiliencyPolicyRequest$policy' => 'The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
', ], ], 'DisruptionResiliencyScore' => [ 'base' => NULL, 'refs' => [ 'ResiliencyScore$disruptionScore' => 'The disruption score for a valid key.
', ], ], 'DisruptionType' => [ 'base' => NULL, 'refs' => [ 'AssessmentCompliance$key' => NULL, 'DisruptionPolicy$key' => NULL, 'DisruptionResiliencyScore$key' => NULL, 'RecommendationCompliance$key' => NULL, ], ], 'DocumentName' => [ 'base' => NULL, 'refs' => [ 'SopRecommendation$name' => 'The name of the SOP recommendation.
', 'TestRecommendation$name' => 'The name of the test recommendation.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'App$resiliencyScore' => 'The current resiliency score for the application.
', 'AppAssessmentSummary$resiliencyScore' => 'The current resiliency score for the application.
', 'AppSummary$resiliencyScore' => 'The current resiliency score for the application.
', 'Cost$amount' => 'The cost amount.
', 'DisruptionResiliencyScore$value' => NULL, 'ResiliencyScore$score' => 'The outage score for a valid key.
', ], ], 'EksNamespace' => [ 'base' => NULL, 'refs' => [ 'EksNamespaceList$member' => NULL, 'EksSourceClusterNamespace$namespace' => 'Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.
', ], ], 'EksNamespaceList' => [ 'base' => NULL, 'refs' => [ 'EksSource$namespaces' => 'The list of namespaces located on your Amazon Elastic Kubernetes Service cluster.
', ], ], 'EksSource' => [ 'base' => 'The input source of the Amazon Elastic Kubernetes Service cluster.
', 'refs' => [ 'EksSourceList$member' => NULL, ], ], 'EksSourceClusterNamespace' => [ 'base' => 'The input source of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.
', 'refs' => [ 'AppInputSource$eksSourceClusterNamespace' => 'The namespace on your Amazon Elastic Kubernetes Service cluster.
', 'DeleteAppInputSourceRequest$eksSourceClusterNamespace' => 'The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application.
', ], ], 'EksSourceList' => [ 'base' => NULL, 'refs' => [ 'ImportResourcesToDraftAppVersionRequest$eksSources' => 'The input sources of the Amazon Elastic Kubernetes Service resources you need to import.
', 'ImportResourcesToDraftAppVersionResponse$eksSources' => 'The input sources of the Amazon Elastic Kubernetes Service resources you have imported.
', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$description' => 'The description of the recommendation.
', 'App$description' => 'The optional description for an app.
', 'AppSummary$description' => 'The optional description for an app.
', 'ConfigRecommendation$description' => 'The optional description for an app.
', 'CreateAppRequest$description' => 'The optional description for an app.
', 'CreateResiliencyPolicyRequest$policyDescription' => 'The description for the policy.
', 'ResiliencyPolicy$policyDescription' => 'The description for the policy.
', 'SuggestedChangesList$member' => NULL, 'TestRecommendation$intent' => 'The intent of the test recommendation.
', 'UpdateAppRequest$description' => 'The optional description for an app.
', 'UpdateResiliencyPolicyRequest$policyDescription' => 'The description for the policy.
', ], ], 'EntityId' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$appComponentName' => 'The Application Component for the CloudWatch alarm recommendation.
', 'AppComponentCompliance$appComponentName' => 'The name of the Application Component.
', 'ComponentRecommendation$appComponentName' => 'The name of the Application Component.
', 'ConfigRecommendation$appComponentName' => 'The name of the Application Component.
', 'SopRecommendation$appComponentName' => 'The name of the Application Component.
', 'TestRecommendation$appComponentName' => 'The name of the Application Component.
', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'App$name' => 'The name for the application.
', 'AppAssessment$assessmentName' => 'The name of the assessment.
', 'AppAssessmentSummary$assessmentName' => 'The name of the assessment.
', 'AppSummary$name' => 'The name of the application.
', 'ConfigRecommendation$name' => 'The name of the recommendation configuration.
', 'CreateAppRequest$name' => 'The name for the application.
', 'CreateAppVersionResourceRequest$resourceName' => 'The name of the resource.
', 'CreateRecommendationTemplateRequest$bucketName' => 'The name of the Amazon S3 bucket that will contain the recommendation template.
', 'CreateRecommendationTemplateRequest$name' => 'The name for the recommendation template.
', 'CreateResiliencyPolicyRequest$policyName' => 'The name of the policy
', 'DeleteAppVersionResourceRequest$resourceName' => 'The name of the resource.
', 'DescribeAppVersionResourceRequest$resourceName' => 'The name of the resource.
', 'EntityNameList$member' => NULL, 'ListAppAssessmentsRequest$assessmentName' => 'The name for the assessment.
', 'ListAppsRequest$name' => 'The name for the one of the listed applications.
', 'ListRecommendationTemplatesRequest$name' => 'The name for one of the listed recommendation templates.
', 'ListResiliencyPoliciesRequest$policyName' => 'The name of the policy
', 'LogicalResourceId$resourceGroupName' => 'The name of the resource group that this resource belongs to.
', 'PhysicalResource$parentResourceName' => 'The name of the parent resource.
', 'PhysicalResource$resourceName' => 'The name of the resource.
', 'RecommendationTemplate$name' => 'The name for the recommendation template.
', 'ResiliencyPolicy$policyName' => 'The name of the policy
', 'ResourceMapping$appRegistryAppName' => 'The name of the application this resource is mapped to.
', 'ResourceMapping$resourceGroupName' => 'The name of the resource group this resource is mapped to.
', 'ResourceMapping$resourceName' => 'The name of the resource this resource is mapped to.
', 'StartAppAssessmentRequest$assessmentName' => 'The name for the assessment.
', 'UpdateAppVersionResourceRequest$resourceName' => 'The name of the resource.
', 'UpdateResiliencyPolicyRequest$policyName' => 'The name of the policy
', ], ], 'EntityNameList' => [ 'base' => NULL, 'refs' => [ 'RemoveDraftAppVersionResourceMappingsRequest$appRegistryAppNames' => 'The names of the registered applications you want to remove from the resource mappings.
', 'RemoveDraftAppVersionResourceMappingsRequest$resourceGroupNames' => 'The names of the resource groups you want to remove from the resource mappings.
', 'RemoveDraftAppVersionResourceMappingsRequest$resourceNames' => 'The names of the resources you want to remove from the resource mappings.
', ], ], 'EntityVersion' => [ 'base' => NULL, 'refs' => [ 'AddDraftAppVersionResourceMappingsResponse$appVersion' => 'The version of the application.
', 'AppAssessment$appVersion' => 'The version of the application.
', 'AppAssessmentSummary$appVersion' => 'The version of the application.
', 'AppVersionSummary$appVersion' => 'The version of the application.
', 'CreateAppVersionAppComponentResponse$appVersion' => 'The Resilience Hub application version.
', 'CreateAppVersionResourceResponse$appVersion' => 'The Resilience Hub application version.
', 'DeleteAppVersionAppComponentResponse$appVersion' => 'The Resilience Hub application version.
', 'DeleteAppVersionResourceResponse$appVersion' => 'The Resilience Hub application version.
', 'DescribeAppVersionAppComponentRequest$appVersion' => 'The Resilience Hub application version.
', 'DescribeAppVersionAppComponentResponse$appVersion' => 'The Resilience Hub application version.
', 'DescribeAppVersionRequest$appVersion' => 'The Resilience Hub application version.
', 'DescribeAppVersionResourceRequest$appVersion' => 'The Resilience Hub application version.
', 'DescribeAppVersionResourceResponse$appVersion' => 'The Resilience Hub application version.
', 'DescribeAppVersionResourcesResolutionStatusRequest$appVersion' => 'The version of the application.
', 'DescribeAppVersionResourcesResolutionStatusResponse$appVersion' => 'The version of the application.
', 'DescribeAppVersionResponse$appVersion' => 'The Resilience Hub application version.
', 'DescribeAppVersionTemplateRequest$appVersion' => 'The version of the application.
', 'DescribeAppVersionTemplateResponse$appVersion' => 'The version of the application.
', 'DescribeDraftAppVersionResourcesImportStatusResponse$appVersion' => 'The version of the application.
', 'ImportResourcesToDraftAppVersionResponse$appVersion' => 'The version of the application.
', 'ListAppInputSourcesRequest$appVersion' => 'The Resilience Hub application version.
', 'ListAppVersionAppComponentsRequest$appVersion' => 'The version of the Application Component.
', 'ListAppVersionAppComponentsResponse$appVersion' => 'The Resilience Hub application version.
', 'ListAppVersionResourceMappingsRequest$appVersion' => 'The version of the application.
', 'ListAppVersionResourcesRequest$appVersion' => 'The version of the application.
', 'ListUnsupportedAppVersionResourcesRequest$appVersion' => 'The version of the application.
', 'PublishAppVersionResponse$appVersion' => 'The version of the application.
', 'PutDraftAppVersionTemplateResponse$appVersion' => 'The version of the application.
', 'RemoveDraftAppVersionResourceMappingsResponse$appVersion' => 'The version of the application.
', 'ResolveAppVersionResourcesRequest$appVersion' => 'The version of the application.
', 'ResolveAppVersionResourcesResponse$appVersion' => 'The version of the application.
', 'StartAppAssessmentRequest$appVersion' => 'The version of the application.
', 'UpdateAppVersionAppComponentResponse$appVersion' => 'The Resilience Hub application version.
', 'UpdateAppVersionResourceResponse$appVersion' => 'The Resilience Hub application version.
', 'UpdateAppVersionResponse$appVersion' => 'The Resilience Hub application version.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ResourceError$reason' => 'This is the error message.
', ], ], 'EstimatedCostTier' => [ 'base' => NULL, 'refs' => [ 'ResiliencyPolicy$estimatedCostTier' => 'Specifies the estimated cost tier of the resiliency policy.
', ], ], 'FailurePolicy' => [ 'base' => 'Defines a failure policy.
', 'refs' => [ 'DisruptionPolicy$value' => NULL, ], ], 'HaArchitecture' => [ 'base' => NULL, 'refs' => [ 'ConfigRecommendation$haArchitecture' => 'The architecture type.
', ], ], 'ImportResourcesToDraftAppVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportResourcesToDraftAppVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'AppInputSource$resourceCount' => 'The number of resources.
', ], ], 'InternalServerException' => [ 'base' => 'This exception occurs when there is an internal failure in the Resilience Hub service.
', 'refs' => [], ], 'ListAlarmRecommendationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAlarmRecommendationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppAssessmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppAssessmentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppComponentCompliancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppComponentCompliancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppComponentRecommendationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppComponentRecommendationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInputSourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInputSourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionAppComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionAppComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionResourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionResourceMappingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRecommendationTemplatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRecommendationTemplatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResiliencyPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResiliencyPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSopRecommendationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSopRecommendationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSuggestedResiliencyPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSuggestedResiliencyPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTestRecommendationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTestRecommendationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUnsupportedAppVersionResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUnsupportedAppVersionResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogicalResourceId' => [ 'base' => 'Defines a logical resource identifier.
', 'refs' => [ 'CreateAppVersionResourceRequest$logicalResourceId' => 'The logical identifier of the resource.
', 'DeleteAppVersionResourceRequest$logicalResourceId' => 'The logical identifier of the resource.
', 'DescribeAppVersionResourceRequest$logicalResourceId' => 'The logical identifier of the resource.
', 'PhysicalResource$logicalResourceId' => 'The logical identifier of the resource.
', 'UnsupportedResource$logicalResourceId' => 'The logical resource identifier for the unsupported resource.
', 'UpdateAppVersionResourceRequest$logicalResourceId' => 'The logical identifier of the resource.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAlarmRecommendationsRequest$maxResults' => 'The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of input sources to be displayed per Resilience Hub application.
', 'ListAppVersionAppComponentsRequest$maxResults' => 'Maximum number of Application Components to be displayed per Resilience Hub application version.
', 'ListAppVersionResourceMappingsRequest$maxResults' => 'The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Null, or the token from a previous call to get the next set of results.
', 'ListAlarmRecommendationsResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListAppAssessmentsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppAssessmentsResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListAppComponentCompliancesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppComponentCompliancesResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListAppComponentRecommendationsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppComponentRecommendationsResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListAppInputSourcesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppInputSourcesResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListAppVersionAppComponentsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppVersionAppComponentsResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListAppVersionResourceMappingsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppVersionResourceMappingsResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListAppVersionResourcesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppVersionResourcesResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListAppVersionsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppVersionsResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListAppsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppsResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListRecommendationTemplatesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListRecommendationTemplatesResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListResiliencyPoliciesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListResiliencyPoliciesResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListSopRecommendationsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListSopRecommendationsResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListSuggestedResiliencyPoliciesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListSuggestedResiliencyPoliciesResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListTestRecommendationsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListTestRecommendationsResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', 'ListUnsupportedAppVersionResourcesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListUnsupportedAppVersionResourcesResponse$nextToken' => 'The token for the next set of results, or null if there are no more results.
', ], ], 'PhysicalIdentifierType' => [ 'base' => NULL, 'refs' => [ 'PhysicalResourceId$type' => 'Specifies the type of physical resource identifier.
The resource identifier is an Amazon Resource Name (ARN) .
The resource identifier is an Resilience Hub-native identifier.
Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or an Resilience Hub-native identifier.
', 'refs' => [ 'CreateAppVersionResourceResponse$physicalResource' => 'Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
', 'DeleteAppVersionResourceResponse$physicalResource' => 'Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
', 'DescribeAppVersionResourceResponse$physicalResource' => 'Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
', 'PhysicalResourceList$member' => NULL, 'UpdateAppVersionResourceResponse$physicalResource' => 'Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
', ], ], 'PhysicalResourceId' => [ 'base' => 'Defines a physical resource identifier.
', 'refs' => [ 'PhysicalResource$physicalResourceId' => 'The physical identifier of the resource.
', 'ResourceMapping$physicalResourceId' => 'The identifier of this resource.
', 'UnsupportedResource$physicalResourceId' => 'The physical resource identifier for the unsupported resource.
', ], ], 'PhysicalResourceList' => [ 'base' => NULL, 'refs' => [ 'ListAppVersionResourcesResponse$physicalResources' => 'The physical resources in the application version.
', ], ], 'PublishAppVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PublishAppVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutDraftAppVersionTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDraftAppVersionTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RecommendationCompliance' => [ 'base' => NULL, 'refs' => [ 'ConfigRecommendation$recommendationCompliance' => 'The expected compliance against the resiliency policy after applying the configuration change.
', ], ], 'RecommendationComplianceStatus' => [ 'base' => NULL, 'refs' => [ 'ComponentRecommendation$recommendationStatus' => 'The recommendation status.
', ], ], 'RecommendationDisruptionCompliance' => [ 'base' => 'Defines a disruption compliance recommendation.
', 'refs' => [ 'RecommendationCompliance$value' => NULL, ], ], 'RecommendationIdList' => [ 'base' => NULL, 'refs' => [ 'CreateRecommendationTemplateRequest$recommendationIds' => 'Identifiers for the recommendations used to create a recommendation template.
', 'RecommendationTemplate$recommendationIds' => 'Identifiers for the recommendations used in the recommendation template.
', ], ], 'RecommendationItem' => [ 'base' => 'Defines a recommendation.
', 'refs' => [ 'RecommendationItemList$member' => NULL, ], ], 'RecommendationItemList' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$items' => 'The list of CloudWatch alarm recommendations.
', 'SopRecommendation$items' => 'The recommendation items.
', 'TestRecommendation$items' => 'The test recommendation items.
', ], ], 'RecommendationTemplate' => [ 'base' => 'Defines a recommendation template created with the CreateRecommendationTemplate action.
', 'refs' => [ 'CreateRecommendationTemplateResponse$recommendationTemplate' => 'The newly created recommendation template, returned as an object. This object includes the template\'s name, format, status, tags, Amazon S3 bucket location, and more.
', 'RecommendationTemplateList$member' => NULL, ], ], 'RecommendationTemplateList' => [ 'base' => NULL, 'refs' => [ 'ListRecommendationTemplatesResponse$recommendationTemplates' => 'The recommendation templates for the Resilience Hub applications.
', ], ], 'RecommendationTemplateStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteRecommendationTemplateResponse$status' => 'The status of the action.
', 'RecommendationTemplate$status' => 'The status of the action.
', 'RecommendationTemplateStatusList$member' => NULL, ], ], 'RecommendationTemplateStatusList' => [ 'base' => NULL, 'refs' => [ 'ListRecommendationTemplatesRequest$status' => 'The status of the action.
', ], ], 'RemoveDraftAppVersionResourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveDraftAppVersionResourceMappingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenderRecommendationType' => [ 'base' => NULL, 'refs' => [ 'RenderRecommendationTypeList$member' => NULL, ], ], 'RenderRecommendationTypeList' => [ 'base' => NULL, 'refs' => [ 'CreateRecommendationTemplateRequest$recommendationTypes' => 'An array of strings that specify the recommendation template type or types.
The template is an AlarmRecommendation template.
The template is a SopRecommendation template.
The template is a TestRecommendation template.
An array of strings that specify the recommendation template type or types.
The template is an AlarmRecommendation template.
The template is a SopRecommendation template.
The template is a TestRecommendation template.
The resiliency policies for the Resilience Hub applications.
', 'ListSuggestedResiliencyPoliciesResponse$resiliencyPolicies' => 'The suggested resiliency policies for the Resilience Hub applications.
', ], ], 'ResiliencyPolicy' => [ 'base' => 'Defines a resiliency policy.
', 'refs' => [ 'AppAssessment$policy' => 'The resiliency policy.
', 'CreateResiliencyPolicyResponse$policy' => 'The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
', 'DescribeResiliencyPolicyResponse$policy' => 'Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.
', 'ResiliencyPolicies$member' => NULL, 'UpdateResiliencyPolicyResponse$policy' => 'The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
', ], ], 'ResiliencyPolicyTier' => [ 'base' => NULL, 'refs' => [ 'CreateResiliencyPolicyRequest$tier' => 'The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
The overall resiliency score, returned as an object that includes the disruption score and outage score.
', 'refs' => [ 'AppAssessment$resiliencyScore' => 'The current resiliency score for the application.
', 'AppComponentCompliance$resiliencyScore' => 'The current resiliency score for the application.
', ], ], 'ResolveAppVersionResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResolveAppVersionResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceError' => [ 'base' => 'Defines application resource errors.
', 'refs' => [ 'ResourceErrorList$member' => NULL, ], ], 'ResourceErrorList' => [ 'base' => NULL, 'refs' => [ 'ResourceErrorsDetails$resourceErrors' => 'A list of errors retrieving an application\'s resources.
', ], ], 'ResourceErrorsDetails' => [ 'base' => 'A list of errors retrieving an application\'s resources.
', 'refs' => [ 'AppAssessment$resourceErrorsDetails' => 'A resource error object containing a list of errors retrieving an application\'s resources.
', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ConflictException$resourceId' => 'The identifier of the resource that the exception applies to.
', 'ResourceNotFoundException$resourceId' => 'The identifier of the resource that the exception applies to.
', ], ], 'ResourceImportStatusType' => [ 'base' => NULL, 'refs' => [ 'DescribeDraftAppVersionResourcesImportStatusResponse$status' => 'The status of the action.
', 'ImportResourcesToDraftAppVersionResponse$status' => 'The status of the action.
', ], ], 'ResourceImportStrategyType' => [ 'base' => NULL, 'refs' => [ 'ImportResourcesToDraftAppVersionRequest$importStrategy' => 'The import strategy you would like to set to import resources into Resilience Hub application.
', ], ], 'ResourceMapping' => [ 'base' => 'Defines a resource mapping.
', 'refs' => [ 'ResourceMappingList$member' => NULL, ], ], 'ResourceMappingList' => [ 'base' => NULL, 'refs' => [ 'AddDraftAppVersionResourceMappingsRequest$resourceMappings' => 'Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
The resource type of the input source.
', 'ResourceMapping$mappingType' => 'Specifies the type of resource mapping.
The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.
The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.
The resource is mapped to another resource. The name of the resource is contained in the resourceName property.
The resource is mapped to Resource Groups. The name of the resource group is contained in the resourceGroupName property.
This exception occurs when the specified resource could not be found.
', 'refs' => [], ], 'ResourceResolutionStatusType' => [ 'base' => NULL, 'refs' => [ 'DescribeAppVersionResourcesResolutionStatusResponse$status' => 'The status of the action.
', 'ResolveAppVersionResourcesResponse$status' => 'The status of the action.
', ], ], 'ResourceSourceType' => [ 'base' => NULL, 'refs' => [ 'PhysicalResource$sourceType' => 'The type of input source.
', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ConflictException$resourceType' => 'The type of the resource that the exception applies to.
', 'ResourceNotFoundException$resourceType' => 'The type of the resource that the exception applies to.
', ], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'ThrottlingException$retryAfterSeconds' => 'The number of seconds to wait before retrying the operation.
', ], ], 'S3Location' => [ 'base' => 'The location of the Amazon S3 bucket.
', 'refs' => [ 'RecommendationTemplate$templatesLocation' => 'The file location of the template.
', ], ], 'S3Url' => [ 'base' => NULL, 'refs' => [ 'TerraformSource$s3StateFileUrl' => 'The URL of the Terraform s3 state file you need to import.
', ], ], 'Seconds' => [ 'base' => NULL, 'refs' => [ 'DisruptionCompliance$achievableRpoInSecs' => 'The Recovery Point Objective (RPO) that is achievable, in seconds.
', 'DisruptionCompliance$achievableRtoInSecs' => 'The Recovery Time Objective (RTO) that is achievable, in seconds
', 'DisruptionCompliance$currentRpoInSecs' => 'The current RPO, in seconds.
', 'DisruptionCompliance$currentRtoInSecs' => 'The current RTO, in seconds.
', 'FailurePolicy$rpoInSecs' => 'The Recovery Point Objective (RPO), in seconds.
', 'FailurePolicy$rtoInSecs' => 'The Recovery Time Objective (RTO), in seconds.
', 'RecommendationDisruptionCompliance$expectedRpoInSecs' => 'The expected RPO after applying the recommended configuration change.
', 'RecommendationDisruptionCompliance$expectedRtoInSecs' => 'The expected RTO after applying the recommended configuration change.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
', 'refs' => [], ], 'SopRecommendation' => [ 'base' => 'Defines a standard operating procedure (SOP) recommendation.
', 'refs' => [ 'SopRecommendationList$member' => NULL, ], ], 'SopRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ListSopRecommendationsResponse$sopRecommendations' => 'The standard operating procedure (SOP) recommendations for the Resilience Hub applications.
', ], ], 'SopServiceType' => [ 'base' => NULL, 'refs' => [ 'SopRecommendation$serviceType' => 'The service type.
', ], ], 'SpecReferenceId' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$referenceId' => 'The reference identifier of the alarm recommendation.
', 'ConfigRecommendation$referenceId' => 'The reference identifier for the recommendation configuration.
', 'SopRecommendation$referenceId' => 'The reference identifier for the SOP recommendation.
', 'TestRecommendation$referenceId' => 'The reference identifier for the test recommendation.
', ], ], 'StartAppAssessmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAppAssessmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'String1024' => [ 'base' => NULL, 'refs' => [ 'AdditionalInfoValueList$member' => NULL, ], ], 'String128WithoutWhitespace' => [ 'base' => NULL, 'refs' => [ 'AdditionalInfoMap$key' => NULL, ], ], 'String2048' => [ 'base' => NULL, 'refs' => [ 'CreateAppVersionResourceRequest$physicalResourceId' => 'The physical identifier of the resource.
', 'DeleteAppVersionResourceRequest$physicalResourceId' => 'The physical identifier of the resource.
', 'DescribeAppVersionResourceRequest$physicalResourceId' => 'The physical identifier of the resource.
', 'UpdateAppVersionResourceRequest$physicalResourceId' => 'The physical identifier of the resource.
', ], ], 'String255' => [ 'base' => NULL, 'refs' => [ 'AppComponent$id' => 'Unique identifier of the Application Component.
', 'AppComponent$name' => 'The name of the Application Component.
', 'AppComponent$type' => 'The type of Application Component.
', 'AppComponentNameList$member' => NULL, 'AppInputSource$sourceName' => 'The name of the input source.
', 'CreateAppVersionAppComponentRequest$id' => 'The identifier of the Application Component.
', 'CreateAppVersionAppComponentRequest$name' => 'The name of the Application Component.
', 'CreateAppVersionAppComponentRequest$type' => 'The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
', 'CreateAppVersionResourceRequest$resourceType' => 'The type of resource.
', 'DeleteAppVersionAppComponentRequest$id' => 'The identifier of the Application Component.
', 'DescribeAppVersionAppComponentRequest$id' => 'The identifier of the Application Component.
', 'DescribeAppVersionResourcesResolutionStatusRequest$resolutionId' => 'The identifier for a specific resolution.
', 'DescribeAppVersionResourcesResolutionStatusResponse$resolutionId' => 'The identifier for a specific resolution.
', 'ListAppVersionResourcesRequest$resolutionId' => 'The identifier for a specific resolution.
', 'ListAppVersionResourcesResponse$resolutionId' => 'The ID for a specific resolution.
', 'ListUnsupportedAppVersionResourcesRequest$resolutionId' => 'The identifier for a specific resolution.
', 'ListUnsupportedAppVersionResourcesResponse$resolutionId' => 'The identifier for a specific resolution.
', 'LogicalResourceId$eksSourceName' => 'The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
The identifier of the resource.
', 'LogicalResourceId$logicalStackName' => 'The name of the CloudFormation stack this resource belongs to.
', 'LogicalResourceId$terraformSourceName' => 'The name of the Terraform S3 state file this resource belongs to.
', 'PhysicalResource$resourceType' => 'The type of resource.
', 'PhysicalResourceId$identifier' => 'The identifier of the physical resource.
', 'ResolveAppVersionResourcesResponse$resolutionId' => 'The identifier for a specific resolution.
', 'ResourceError$logicalResourceId' => 'This is the identifier of the resource.
', 'ResourceError$physicalResourceId' => 'This is the identifier of the physical resource.
', 'ResourceMapping$eksSourceName' => 'The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
The name of the CloudFormation stack this resource is mapped to.
', 'ResourceMapping$terraformSourceName' => 'The short name of the Terraform source.
', 'String255List$member' => NULL, 'UnsupportedResource$resourceType' => 'The type of resource.
', 'UnsupportedResource$unsupportedResourceStatus' => 'The status of the unsupported resource.
', 'UpdateAppVersionAppComponentRequest$id' => 'The identifier of the Application Component.
', 'UpdateAppVersionAppComponentRequest$name' => 'The name of the Application Component.
', 'UpdateAppVersionAppComponentRequest$type' => 'The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
', 'UpdateAppVersionResourceRequest$resourceType' => 'The type of resource.
', ], ], 'String255List' => [ 'base' => NULL, 'refs' => [ 'RemoveDraftAppVersionResourceMappingsRequest$eksSourceNames' => 'The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from the resource mappings.
This parameter accepts values in "eks-cluster/namespace" format.
The names of the CloudFormation stacks you want to remove from the resource mappings.
', 'RemoveDraftAppVersionResourceMappingsRequest$terraformSourceNames' => 'The names of the Terraform sources you want to remove from the resource mappings.
', ], ], 'String500' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'AlarmRecommendation$name' => 'The name of the alarm recommendation.
', 'AlarmRecommendation$prerequisite' => 'The prerequisite for the alarm recommendation.
', 'AlarmReferenceIdList$member' => NULL, 'AppAssessment$message' => 'Error or warning message from the assessment execution
', 'AppAssessmentSummary$message' => 'The message from the assessment run.
', 'AppComponentCompliance$message' => 'The compliance message.
', 'ConflictException$message' => NULL, 'DescribeAppVersionResourcesResolutionStatusResponse$errorMessage' => 'The returned error message for the request.
', 'DescribeDraftAppVersionResourcesImportStatusResponse$errorMessage' => 'The returned error message for the request.
', 'DisruptionCompliance$message' => 'The disruption compliance message.
', 'DisruptionCompliance$rpoDescription' => 'The RPO description.
', 'DisruptionCompliance$rpoReferenceId' => 'The RPO reference identifier.
', 'DisruptionCompliance$rtoDescription' => 'The RTO description.
', 'DisruptionCompliance$rtoReferenceId' => 'The RTO reference identifier.
', 'InternalServerException$message' => NULL, 'RecommendationDisruptionCompliance$expectedRpoDescription' => 'The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.
', 'RecommendationDisruptionCompliance$expectedRtoDescription' => 'The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.
', 'RecommendationItem$resourceId' => 'The resource identifier.
', 'RecommendationTemplate$message' => 'The message for the recommendation template.
', 'ResourceNotFoundException$message' => NULL, 'S3Location$bucket' => 'The name of the Amazon S3 bucket.
', 'S3Location$prefix' => 'The prefix for the Amazon S3 bucket.
', 'ServiceQuotaExceededException$message' => NULL, 'SopRecommendation$description' => 'The description of the SOP recommendation.
', 'SopRecommendation$prerequisite' => 'The prerequisite for the SOP recommendation.
', 'TestRecommendation$description' => 'The description for the test recommendation.
', 'TestRecommendation$prerequisite' => 'The prerequisite of the test recommendation.
', 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'SuggestedChangesList' => [ 'base' => NULL, 'refs' => [ 'ConfigRecommendation$suggestedChanges' => 'List of the suggested configuration changes.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The keys of the tags you want to remove.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'App$tags' => 'The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'AppAssessment$tags' => 'The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'CreateAppRequest$tags' => 'The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'CreateRecommendationTemplateRequest$tags' => 'The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'CreateResiliencyPolicyRequest$tags' => 'The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'ListTagsForResourceResponse$tags' => 'The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'RecommendationTemplate$tags' => 'The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'ResiliencyPolicy$tags' => 'The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'StartAppAssessmentRequest$tags' => 'The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'TagResourceRequest$tags' => 'The tags to assign to the resource. Each tag consists of a key/value pair.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'TemplateFormat' => [ 'base' => NULL, 'refs' => [ 'CreateRecommendationTemplateRequest$format' => 'The format for the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
The format of the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
The Terraform s3 state file you need to import.
', 'refs' => [ 'AppInputSource$terraformSource' => 'The name of the Terraform s3 state file.
', 'DeleteAppInputSourceRequest$terraformSource' => 'The imported Terraform s3 state file you want to remove from the Resilience Hub application.
', 'TerraformSourceList$member' => NULL, ], ], 'TerraformSourceList' => [ 'base' => NULL, 'refs' => [ 'ImportResourcesToDraftAppVersionRequest$terraformSources' => 'A list of terraform file s3 URLs you need to import.
', 'ImportResourcesToDraftAppVersionResponse$terraformSources' => 'A list of terraform file s3 URLs you have imported.
', ], ], 'TestRecommendation' => [ 'base' => 'Defines a test recommendation.
', 'refs' => [ 'TestRecommendationList$member' => NULL, ], ], 'TestRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ListTestRecommendationsResponse$testRecommendations' => 'The test recommendations for the Resilience Hub application.
', ], ], 'TestRisk' => [ 'base' => NULL, 'refs' => [ 'TestRecommendation$risk' => 'The level of risk for this test recommendation.
', ], ], 'TestType' => [ 'base' => NULL, 'refs' => [ 'TestRecommendation$type' => 'The type of test recommendation.
', ], ], 'ThrottlingException' => [ 'base' => 'This exception occurs when you have exceeded the limit on the number of requests per second.
', 'refs' => [], ], 'TimeStamp' => [ 'base' => NULL, 'refs' => [ 'App$creationTime' => 'The timestamp for when the app was created.
', 'App$lastAppComplianceEvaluationTime' => 'The timestamp for the most recent compliance evaluation.
', 'App$lastResiliencyScoreEvaluationTime' => 'The timestamp for the most recent resiliency score evaluation.
', 'AppAssessment$endTime' => 'The end time for the action.
', 'AppAssessment$startTime' => 'The starting time for the action.
', 'AppAssessmentSummary$endTime' => 'The end time for the action.
', 'AppAssessmentSummary$startTime' => 'The starting time for the action.
', 'AppSummary$creationTime' => 'The timestamp for when the app was created.
', 'DescribeDraftAppVersionResourcesImportStatusResponse$statusChangeTime' => 'The timestamp for when the status last changed.
', 'RecommendationTemplate$endTime' => 'The end time for the action.
', 'RecommendationTemplate$startTime' => 'The start time for the action.
', 'ResiliencyPolicy$creationTime' => 'The timestamp for when the resiliency policy was created.
', ], ], 'UnsupportedResource' => [ 'base' => 'Defines a resource that is not supported by Resilience Hub.
', 'refs' => [ 'UnsupportedResourceList$member' => NULL, ], ], 'UnsupportedResourceList' => [ 'base' => NULL, 'refs' => [ 'ListUnsupportedAppVersionResourcesResponse$unsupportedResources' => 'The unsupported resources for the application.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionAppComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionAppComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResiliencyPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResiliencyPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Uuid' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$recommendationId' => 'The identifier of the alarm recommendation.
', 'RecommendationIdList$member' => NULL, 'SopRecommendation$recommendationId' => 'Identifier for the SOP recommendation.
', 'TestRecommendation$recommendationId' => 'Identifier for the test recommendation.
', ], ], 'ValidationException' => [ 'base' => 'This exception occurs when a request is not valid.
', 'refs' => [], ], ],]; +return [ 'version' => '2.0', 'service' => 'Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. It offers continual resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production.
', 'operations' => [ 'AddDraftAppVersionResourceMappings' => 'Adds the resource mapping for the draft application version. You can also update an existing resource mapping to a new physical resource.
', 'BatchUpdateRecommendationStatus' => 'Enables you to include or exclude one or more operational recommendations.
', 'CreateApp' => 'Creates an Resilience Hub application. An Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas.
After you create an Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).
', 'CreateAppVersionAppComponent' => 'Creates a new Application Component in the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Adds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must call ResolveAppVersionResources API.
Creates a new recommendation template for the Resilience Hub application.
', 'CreateResiliencyPolicy' => 'Creates a resiliency policy for an application.
', 'DeleteApp' => 'Deletes an Resilience Hub application. This is a destructive action that can\'t be undone.
', 'DeleteAppAssessment' => 'Deletes an Resilience Hub application assessment. This is a destructive action that can\'t be undone.
', 'DeleteAppInputSource' => 'Deletes the input source and all of its imported resources from the Resilience Hub application.
', 'DeleteAppVersionAppComponent' => 'Deletes an Application Component from the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
You will not be able to delete an Application Component if it has resources associated with it.
Deletes a resource from the Resilience Hub application.
You can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Deletes a recommendation template. This is a destructive action that can\'t be undone.
', 'DeleteResiliencyPolicy' => 'Deletes a resiliency policy. This is a destructive action that can\'t be undone.
', 'DescribeApp' => 'Describes an Resilience Hub application.
', 'DescribeAppAssessment' => 'Describes an assessment for an Resilience Hub application.
', 'DescribeAppVersion' => 'Describes the Resilience Hub application version.
', 'DescribeAppVersionAppComponent' => 'Describes an Application Component in the Resilience Hub application.
', 'DescribeAppVersionResource' => 'Describes a resource of the Resilience Hub application.
This API accepts only one of the following parameters to descibe the resource:
resourceName
logicalResourceId
physicalResourceId (Along with physicalResourceId, you can also provide awsAccountId, and awsRegion)
Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.
Describes details about an Resilience Hub application.
', 'DescribeDraftAppVersionResourcesImportStatus' => 'Describes the status of importing resources to an application version.
If you get a 404 error with ResourceImportStatusNotFoundAppMetadataException, you must call importResourcesToDraftAppVersion after creating the application and before calling describeDraftAppVersionResourcesImportStatus to obtain the status.
Describes a specified resiliency policy for an Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.
', 'ImportResourcesToDraftAppVersion' => 'Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
', 'ListAlarmRecommendations' => 'Lists the alarm recommendations for an Resilience Hub application.
', 'ListAppAssessmentComplianceDrifts' => 'List of compliance drifts that were detected while running an assessment.
', 'ListAppAssessments' => 'Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.
', 'ListAppComponentCompliances' => 'Lists the compliances for an Resilience Hub Application Component.
', 'ListAppComponentRecommendations' => 'Lists the recommendations for an Resilience Hub Application Component.
', 'ListAppInputSources' => 'Lists all the input sources of the Resilience Hub application. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
', 'ListAppVersionAppComponents' => 'Lists all the Application Components in the Resilience Hub application.
', 'ListAppVersionResourceMappings' => 'Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.
', 'ListAppVersionResources' => 'Lists all the resources in an Resilience Hub application.
', 'ListAppVersions' => 'Lists the different versions for the Resilience Hub applications.
', 'ListApps' => 'Lists your Resilience Hub applications.
You can filter applications using only one filter at a time or without using any filter. If you try to filter applications using multiple filters, you will get the following error:
An error occurred (ValidationException) when calling the ListApps operation: Only one filter is supported for this operation.
Lists the recommendation templates for the Resilience Hub applications.
', 'ListResiliencyPolicies' => 'Lists the resiliency policies for the Resilience Hub applications.
', 'ListSopRecommendations' => 'Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
', 'ListSuggestedResiliencyPolicies' => 'Lists the suggested resiliency policies for the Resilience Hub applications.
', 'ListTagsForResource' => 'Lists the tags for your resources in your Resilience Hub applications.
', 'ListTestRecommendations' => 'Lists the test recommendations for the Resilience Hub application.
', 'ListUnsupportedAppVersionResources' => 'Lists the resources that are not currently supported in Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub.
', 'PublishAppVersion' => 'Publishes a new version of a specific Resilience Hub application.
', 'PutDraftAppVersionTemplate' => 'Adds or updates the app template for an Resilience Hub application draft version.
', 'RemoveDraftAppVersionResourceMappings' => 'Removes resource mappings from a draft application version.
', 'ResolveAppVersionResources' => 'Resolves the resources for an application version.
', 'StartAppAssessment' => 'Creates a new application assessment for an application.
', 'TagResource' => 'Applies one or more tags to a resource.
', 'UntagResource' => 'Removes one or more tags from a resource.
', 'UpdateApp' => 'Updates an application.
', 'UpdateAppVersion' => 'Updates the Resilience Hub application version.
This API updates the Resilience Hub application draft version. To use this information for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Updates an existing Application Component in the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Updates the resource details in the Resilience Hub application.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must call ResolveAppVersionResources API.
Updates a resiliency policy.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You don\'t have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.
', 'refs' => [], ], 'AddDraftAppVersionResourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddDraftAppVersionResourceMappingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'AdditionalInfoMap' => [ 'base' => NULL, 'refs' => [ 'AppComponent$additionalInfo' => 'Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
Currently, there is no supported additional information for Application Components.
', 'CreateAppVersionResourceRequest$additionalInfo' => 'Currently, there is no supported additional information for resources.
', 'DescribeAppVersionResponse$additionalInfo' => 'Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter supports only failover region and account.
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
Currently, there is no supported additional information for Application Components.
', 'UpdateAppVersionRequest$additionalInfo' => 'Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
Currently, there is no supported additional information for resources.
', 'UpdateAppVersionResponse$additionalInfo' => 'Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter supports only failover region and account.
Defines a recommendation for a CloudWatch alarm.
', 'refs' => [ 'AlarmRecommendationList$member' => NULL, ], ], 'AlarmRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ListAlarmRecommendationsResponse$alarmRecommendations' => 'The alarm recommendations for an Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.
', ], ], 'AlarmReferenceIdList' => [ 'base' => NULL, 'refs' => [ 'TestRecommendation$dependsOnAlarms' => 'A list of recommended alarms that are used in the test and must be exported before or with the test.
', ], ], 'AlarmType' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$type' => 'Type of alarm recommendation.
', ], ], 'App' => [ 'base' => 'Defines an Resilience Hub application.
', 'refs' => [ 'CreateAppResponse$app' => 'The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.
', 'DescribeAppResponse$app' => 'The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
', 'UpdateAppResponse$app' => 'The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
', ], ], 'AppAssessment' => [ 'base' => 'Defines an application assessment.
', 'refs' => [ 'DescribeAppAssessmentResponse$assessment' => 'The assessment for an Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.
', 'StartAppAssessmentResponse$assessment' => 'The assessment created.
', ], ], 'AppAssessmentScheduleType' => [ 'base' => NULL, 'refs' => [ 'App$assessmentSchedule' => 'Assessment execution schedule with \'Daily\' or \'Disabled\' values.
', 'AppSummary$assessmentSchedule' => 'Assessment execution schedule with \'Daily\' or \'Disabled\' values.
', 'CreateAppRequest$assessmentSchedule' => 'Assessment execution schedule with \'Daily\' or \'Disabled\' values.
', 'UpdateAppRequest$assessmentSchedule' => 'Assessment execution schedule with \'Daily\' or \'Disabled\' values.
', ], ], 'AppAssessmentSummary' => [ 'base' => 'Defines an application assessment summary.
', 'refs' => [ 'AppAssessmentSummaryList$member' => NULL, ], ], 'AppAssessmentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAppAssessmentsResponse$assessmentSummaries' => 'The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.
', ], ], 'AppComplianceStatusType' => [ 'base' => NULL, 'refs' => [ 'App$complianceStatus' => 'Current status of compliance for the resiliency policy.
', 'AppSummary$complianceStatus' => 'The current status of compliance for the resiliency policy.
', ], ], 'AppComponent' => [ 'base' => 'Defines an Application Component.
', 'refs' => [ 'AppComponentList$member' => NULL, 'CreateAppVersionAppComponentResponse$appComponent' => 'List of Application Components that belong to this resource.
', 'DeleteAppVersionAppComponentResponse$appComponent' => 'List of Application Components that belong to this resource.
', 'DescribeAppVersionAppComponentResponse$appComponent' => 'List of Application Components that belong to this resource.
', 'UpdateAppVersionAppComponentResponse$appComponent' => 'List of Application Components that belong to this resource.
', ], ], 'AppComponentCompliance' => [ 'base' => 'Defines the compliance of an Application Component against the resiliency policy.
', 'refs' => [ 'ComponentCompliancesList$member' => NULL, ], ], 'AppComponentList' => [ 'base' => NULL, 'refs' => [ 'ListAppVersionAppComponentsResponse$appComponents' => 'Defines an Application Component.
', 'PhysicalResource$appComponents' => 'The application components that belong to this resource.
', ], ], 'AppComponentNameList' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$appComponentNames' => 'List of Application Component names for the CloudWatch alarm recommendation.
', 'CreateAppVersionResourceRequest$appComponents' => 'List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
', 'UpdateAppVersionResourceRequest$appComponents' => 'List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
', ], ], 'AppDriftStatusType' => [ 'base' => NULL, 'refs' => [ 'App$driftStatus' => 'Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
', 'AppSummary$driftStatus' => 'Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
', ], ], 'AppInputSource' => [ 'base' => 'The list of Resilience Hub application input sources.
', 'refs' => [ 'AppInputSourceList$member' => NULL, 'DeleteAppInputSourceResponse$appInputSource' => 'Name of the input source from where the application resource is imported from.
', ], ], 'AppInputSourceList' => [ 'base' => NULL, 'refs' => [ 'ListAppInputSourcesResponse$appInputSources' => 'The list of Resilience Hub application input sources.
', ], ], 'AppStatusType' => [ 'base' => NULL, 'refs' => [ 'App$status' => 'Status of the application.
', 'AppSummary$status' => 'Status of the application.
', ], ], 'AppSummary' => [ 'base' => 'Defines an application summary.
', 'refs' => [ 'AppSummaryList$member' => NULL, ], ], 'AppSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAppsResponse$appSummaries' => 'Summaries for the Resilience Hub application.
', ], ], 'AppTemplateBody' => [ 'base' => NULL, 'refs' => [ 'DescribeAppVersionTemplateResponse$appTemplateBody' => 'A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.
The appTemplateBody JSON string has the following structure:
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don\'t add the resources that you want to exclude.
Each resources array item includes the following fields:
logicalResourceId
Logical identifier of the resource.
Type: Object
Each logicalResourceId object includes the following fields:
identifier
Identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
type
The type of resource.
Type: string
name
The name of the resource.
Type: String
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
appComponents
List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each appComponents array item includes the following fields:
name
Name of the Application Component.
Type: String
type
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don\'t add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
Logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
Each logicalResourceIds object includes the following fields:
identifier
Identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
version
Resilience Hub application version.
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.
The appTemplateBody JSON string has the following structure:
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don\'t add the resources that you want to exclude.
Each resources array item includes the following fields:
logicalResourceId
Logical identifier of the resource.
Type: Object
Each logicalResourceId object includes the following fields:
identifier
Identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
type
The type of resource.
Type: string
name
The name of the resource.
Type: String
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
appComponents
List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each appComponents array item includes the following fields:
name
Name of the Application Component.
Type: String
type
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don\'t add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
Logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
Each logicalResourceIds object includes the following fields:
identifier
Identifier of the resource.
Type: String
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
version
Resilience Hub application version.
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key: "failover-regions"
Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
The version of the application.
', ], ], 'AppVersionSummary' => [ 'base' => 'Version of an application.
', 'refs' => [ 'AppVersionList$member' => NULL, ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AddDraftAppVersionResourceMappingsRequest$appArn' => 'Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
', 'AppSummary$appArn' => 'Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) of the imported resource you want to remove from the Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
', 'DeleteAppInputSourceResponse$appArn' => 'Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for a recommendation template.
', 'DeleteRecommendationTemplateResponse$recommendationTemplateArn' => 'The Amazon Resource Name (ARN) for a recommendation template.
', 'DeleteResiliencyPolicyRequest$policyArn' => 'Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for a recommendation template.
', 'ListSopRecommendationsRequest$assessmentArn' => 'Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.
', 'ListTestRecommendationsRequest$assessmentArn' => 'Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) for the recommendation template.
', 'RemoveDraftAppVersionResourceMappingsRequest$appArn' => 'Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resource.
', 'UntagResourceRequest$resourceArn' => 'Amazon Resource Name (ARN) of the resource.
', 'UpdateAppRequest$appArn' => 'Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
The Amazon Resource Names (ARNs) for the resources.
', 'ImportResourcesToDraftAppVersionResponse$sourceArns' => 'The Amazon Resource Names (ARNs) for the resources you have imported.
', ], ], 'AssessmentCompliance' => [ 'base' => NULL, 'refs' => [ 'AppAssessment$compliance' => 'Application compliance against the resiliency policy.
', 'AppComponentCompliance$compliance' => 'The compliance of the Application Component against the resiliency policy.
', 'ComplianceDrift$actualValue' => 'Actual compliance value of the entity.
', 'ComplianceDrift$expectedValue' => 'The expected compliance value of an entity.
', 'ConfigRecommendation$compliance' => 'The current compliance against the resiliency policy before applying the configuration change.
', ], ], 'AssessmentInvoker' => [ 'base' => NULL, 'refs' => [ 'AppAssessment$invoker' => 'The entity that invoked the assessment.
', 'AppAssessmentSummary$invoker' => 'Entity that invoked the assessment.
', 'ListAppAssessmentsRequest$invoker' => 'Specifies the entity that invoked a specific assessment, either a User or the System.
Current status of the assessment for the resiliency policy.
', 'AppAssessmentSummary$assessmentStatus' => 'Current status of the assessment for the resiliency policy.
', 'AssessmentStatusList$member' => NULL, 'DeleteAppAssessmentResponse$assessmentStatus' => 'The current status of the assessment for the resiliency policy.
', ], ], 'AssessmentStatusList' => [ 'base' => NULL, 'refs' => [ 'ListAppAssessmentsRequest$assessmentStatus' => 'The current status of the assessment for the resiliency policy.
', ], ], 'AwsRegion' => [ 'base' => NULL, 'refs' => [ 'CreateAppVersionResourceRequest$awsRegion' => 'Amazon Web Services region that owns the physical resource.
', 'DeleteAppVersionResourceRequest$awsRegion' => 'Amazon Web Services region that owns the physical resource.
', 'DescribeAppVersionResourceRequest$awsRegion' => 'Amazon Web Services region that owns the physical resource.
', 'PhysicalResourceId$awsRegion' => 'The Amazon Web Services Region that the physical resource is located in.
', 'RecommendationItem$targetRegion' => 'The target region.
', 'UpdateAppVersionResourceRequest$awsRegion' => 'Amazon Web Services region that owns the physical resource.
', 'UpdateRecommendationStatusItem$targetRegion' => 'Identifier of the target Amazon Web Services Region.
', ], ], 'BatchUpdateRecommendationStatusFailedEntries' => [ 'base' => NULL, 'refs' => [ 'BatchUpdateRecommendationStatusResponse$failedEntries' => 'A list of items with error details about each item, which could not be included or excluded.
', ], ], 'BatchUpdateRecommendationStatusFailedEntry' => [ 'base' => 'List of operational recommendations that did not get included or excluded.
', 'refs' => [ 'BatchUpdateRecommendationStatusFailedEntries$member' => NULL, ], ], 'BatchUpdateRecommendationStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchUpdateRecommendationStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchUpdateRecommendationStatusSuccessfulEntries' => [ 'base' => NULL, 'refs' => [ 'BatchUpdateRecommendationStatusResponse$successfulEntries' => 'A list of items that were included or excluded.
', ], ], 'BatchUpdateRecommendationStatusSuccessfulEntry' => [ 'base' => 'List of operational recommendations that were successfully included or excluded.
', 'refs' => [ 'BatchUpdateRecommendationStatusSuccessfulEntries$member' => NULL, ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'BatchUpdateRecommendationStatusSuccessfulEntry$excluded' => 'Indicates if the operational recommendation was successfully excluded.
', 'DeleteAppRequest$forceDelete' => 'A boolean option to force the deletion of an Resilience Hub application.
', 'ListAppAssessmentsRequest$reverseOrder' => 'The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.
The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.
Indicates if a resource is included or excluded from the assessment.
', 'RecommendationItem$alreadyImplemented' => 'Specifies if the recommendation has already been implemented.
', 'RecommendationItem$excluded' => 'Indicates if an operational recommendation item is excluded.
', 'RecommendationTemplate$needsReplacements' => 'Indicates if replacements are needed.
', 'ResourceErrorsDetails$hasMoreErrors' => 'This indicates if there are more errors not listed in the resourceErrors list.
', 'UpdateAppRequest$clearResiliencyPolicyArn' => 'Specifies if the resiliency policy ARN should be cleared.
', 'UpdateAppVersionResourceRequest$excluded' => 'Indicates if a resource is excluded from an Resilience Hub application.
You can exclude only imported resources from an Resilience Hub application.
Indicates if the operational recommendation needs to be excluded. If set to True, the operational recommendation will be excluded.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateAppRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'CreateAppVersionAppComponentRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'CreateAppVersionResourceRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'CreateRecommendationTemplateRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'CreateResiliencyPolicyRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppAssessmentRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppInputSourceRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppVersionAppComponentRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteAppVersionResourceRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteRecommendationTemplateRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'DeleteResiliencyPolicyRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', 'StartAppAssessmentRequest$clientToken' => 'Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
', ], ], 'ComplianceDrift' => [ 'base' => 'Indicates the compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) that were detected for an assessed entity.
', 'refs' => [ 'ComplianceDriftList$member' => NULL, ], ], 'ComplianceDriftList' => [ 'base' => NULL, 'refs' => [ 'ListAppAssessmentComplianceDriftsResponse$complianceDrifts' => 'Indicates compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) detected for an assessed entity.
', ], ], 'ComplianceStatus' => [ 'base' => NULL, 'refs' => [ 'AppAssessment$complianceStatus' => 'Current status of the compliance for the resiliency policy.
', 'AppAssessmentSummary$complianceStatus' => 'TCurrent status of compliance for the resiliency policy.
', 'AppComponentCompliance$status' => 'Status of the action.
', 'DisruptionCompliance$complianceStatus' => 'The current status of compliance for the resiliency policy.
', 'ListAppAssessmentsRequest$complianceStatus' => 'The current status of compliance for the resiliency policy.
', 'RecommendationDisruptionCompliance$expectedComplianceStatus' => 'The expected compliance status after applying the recommended configuration change.
', ], ], 'ComponentCompliancesList' => [ 'base' => NULL, 'refs' => [ 'ListAppComponentCompliancesResponse$componentCompliances' => 'The compliances for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and more.
', ], ], 'ComponentRecommendation' => [ 'base' => 'Defines recommendations for an Resilience Hub Application Component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.
', 'refs' => [ 'ComponentRecommendationList$member' => NULL, ], ], 'ComponentRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ListAppComponentRecommendationsResponse$componentRecommendations' => 'The recommendations for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, configuration recommendations, and recommendation statuses.
', ], ], 'ConfigRecommendation' => [ 'base' => 'Defines a recommendation configuration.
', 'refs' => [ 'ConfigRecommendationList$member' => NULL, ], ], 'ConfigRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ComponentRecommendation$configRecommendations' => 'List of recommendations.
', ], ], 'ConfigRecommendationOptimizationType' => [ 'base' => NULL, 'refs' => [ 'ConfigRecommendation$optimizationType' => 'The type of optimization.
', ], ], 'ConflictException' => [ 'base' => 'This exception occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
', 'refs' => [], ], 'Cost' => [ 'base' => 'Defines a cost object.
', 'refs' => [ 'AppAssessment$cost' => 'Cost for the application.
', 'AppAssessmentSummary$cost' => 'Cost for an application.
', 'AppComponentCompliance$cost' => 'The cost for the application.
', 'ConfigRecommendation$cost' => 'The cost for the application.
', ], ], 'CostFrequency' => [ 'base' => NULL, 'refs' => [ 'Cost$frequency' => 'The cost frequency.
', ], ], 'CreateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppVersionAppComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppVersionAppComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppVersionResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppVersionResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecommendationTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecommendationTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResiliencyPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResiliencyPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'CurrencyCode' => [ 'base' => NULL, 'refs' => [ 'Cost$currency' => 'The cost currency, for example USD.
Amazon Web Services account that owns the physical resource.
', 'DeleteAppVersionResourceRequest$awsAccountId' => 'Amazon Web Services account that owns the physical resource.
', 'DescribeAppVersionResourceRequest$awsAccountId' => 'Amazon Web Services account that owns the physical resource.
', 'PhysicalResourceId$awsAccountId' => 'The Amazon Web Services account that owns the physical resource.
', 'RecommendationItem$targetAccountId' => 'Identifier of the target account.
', 'UpdateAppVersionResourceRequest$awsAccountId' => 'Amazon Web Services account that owns the physical resource.
', 'UpdateRecommendationStatusItem$targetAccountId' => 'Identifier of the target Amazon Web Services account.
', ], ], 'DataLocationConstraint' => [ 'base' => NULL, 'refs' => [ 'CreateResiliencyPolicyRequest$dataLocationConstraint' => 'Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
', 'ResiliencyPolicy$dataLocationConstraint' => 'Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
', 'UpdateResiliencyPolicyRequest$dataLocationConstraint' => 'Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
', ], ], 'DeleteAppAssessmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppAssessmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppInputSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppInputSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppVersionAppComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppVersionAppComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppVersionResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppVersionResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRecommendationTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRecommendationTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResiliencyPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResiliencyPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppAssessmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppAssessmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionAppComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionAppComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResourcesResolutionStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResourcesResolutionStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppVersionTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDraftAppVersionResourcesImportStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDraftAppVersionResourcesImportStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResiliencyPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResiliencyPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DifferenceType' => [ 'base' => NULL, 'refs' => [ 'ComplianceDrift$diffType' => 'Difference type between actual and expected recovery point objective (RPO) and recovery time objective (RTO) values. Currently, Resilience Hub supports only NotEqual difference type.
', ], ], 'DisruptionCompliance' => [ 'base' => 'Defines the compliance against the resiliency policy for a disruption.
', 'refs' => [ 'AssessmentCompliance$value' => NULL, ], ], 'DisruptionPolicy' => [ 'base' => NULL, 'refs' => [ 'CreateResiliencyPolicyRequest$policy' => 'The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
', 'ResiliencyPolicy$policy' => 'The resiliency policy.
', 'UpdateResiliencyPolicyRequest$policy' => 'The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
', ], ], 'DisruptionResiliencyScore' => [ 'base' => NULL, 'refs' => [ 'ResiliencyScore$disruptionScore' => 'The disruption score for a valid key.
', ], ], 'DisruptionType' => [ 'base' => NULL, 'refs' => [ 'AssessmentCompliance$key' => NULL, 'DisruptionPolicy$key' => NULL, 'DisruptionResiliencyScore$key' => NULL, 'RecommendationCompliance$key' => NULL, ], ], 'DocumentName' => [ 'base' => NULL, 'refs' => [ 'SopRecommendation$name' => 'Name of the SOP recommendation.
', 'TestRecommendation$name' => 'Name of the test recommendation.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'App$resiliencyScore' => 'Current resiliency score for the application.
', 'AppAssessmentSummary$resiliencyScore' => 'Current resiliency score for the application.
', 'AppSummary$resiliencyScore' => 'The current resiliency score for the application.
', 'Cost$amount' => 'The cost amount.
', 'DisruptionResiliencyScore$value' => NULL, 'ResiliencyScore$score' => 'The outage score for a valid key.
', ], ], 'DriftStatus' => [ 'base' => NULL, 'refs' => [ 'AppAssessment$driftStatus' => 'Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
', 'AppAssessmentSummary$driftStatus' => 'Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
', ], ], 'DriftType' => [ 'base' => NULL, 'refs' => [ 'ComplianceDrift$driftType' => 'The type of drift detected. Currently, Resilience Hub supports only ApplicationCompliance drift type.
', ], ], 'EksNamespace' => [ 'base' => NULL, 'refs' => [ 'EksNamespaceList$member' => NULL, 'EksSourceClusterNamespace$namespace' => 'Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.
', ], ], 'EksNamespaceList' => [ 'base' => NULL, 'refs' => [ 'EksSource$namespaces' => 'The list of namespaces located on your Amazon Elastic Kubernetes Service cluster.
', ], ], 'EksSource' => [ 'base' => 'The input source of the Amazon Elastic Kubernetes Service cluster.
', 'refs' => [ 'EksSourceList$member' => NULL, ], ], 'EksSourceClusterNamespace' => [ 'base' => 'The input source of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.
', 'refs' => [ 'AppInputSource$eksSourceClusterNamespace' => 'The namespace on your Amazon Elastic Kubernetes Service cluster.
', 'DeleteAppInputSourceRequest$eksSourceClusterNamespace' => 'The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application.
', ], ], 'EksSourceList' => [ 'base' => NULL, 'refs' => [ 'ImportResourcesToDraftAppVersionRequest$eksSources' => 'The input sources of the Amazon Elastic Kubernetes Service resources you need to import.
', 'ImportResourcesToDraftAppVersionResponse$eksSources' => 'The input sources of the Amazon Elastic Kubernetes Service resources you have imported.
', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$description' => 'Description of the alarm recommendation.
', 'App$description' => 'Optional description for an application.
', 'AppSummary$description' => 'The optional description for an app.
', 'ConfigRecommendation$description' => 'The optional description for an app.
', 'CreateAppRequest$description' => 'The optional description for an app.
', 'CreateResiliencyPolicyRequest$policyDescription' => 'The description for the policy.
', 'ResiliencyPolicy$policyDescription' => 'The description for the policy.
', 'SuggestedChangesList$member' => NULL, 'TestRecommendation$intent' => 'Intent of the test recommendation.
', 'UpdateAppRequest$description' => 'The optional description for an app.
', 'UpdateResiliencyPolicyRequest$policyDescription' => 'The description for the policy.
', ], ], 'EntityId' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$appComponentName' => 'Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list.
Name of the Application Component.
', 'ComponentRecommendation$appComponentName' => 'Name of the Application Component.
', 'ConfigRecommendation$appComponentName' => 'Name of the Application Component.
', 'SopRecommendation$appComponentName' => 'Name of the Application Component.
', 'TestRecommendation$appComponentName' => 'Name of the Application Component.
', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'App$name' => 'Name for the application.
', 'AppAssessment$assessmentName' => 'Name of the assessment.
', 'AppAssessmentSummary$assessmentName' => 'Name of the assessment.
', 'AppSummary$name' => 'The name of the application.
', 'ConfigRecommendation$name' => 'The name of the recommendation configuration.
', 'CreateAppRequest$name' => 'Name of the application.
', 'CreateAppVersionResourceRequest$resourceName' => 'Name of the resource.
', 'CreateRecommendationTemplateRequest$bucketName' => 'The name of the Amazon S3 bucket that will contain the recommendation template.
', 'CreateRecommendationTemplateRequest$name' => 'The name for the recommendation template.
', 'CreateResiliencyPolicyRequest$policyName' => 'The name of the policy
', 'DeleteAppVersionResourceRequest$resourceName' => 'Name of the resource.
', 'DescribeAppVersionResourceRequest$resourceName' => 'Name of the resource.
', 'EntityNameList$member' => NULL, 'ListAppAssessmentsRequest$assessmentName' => 'The name for the assessment.
', 'ListAppsRequest$name' => 'The name for the one of the listed applications.
', 'ListRecommendationTemplatesRequest$name' => 'The name for one of the listed recommendation templates.
', 'ListResiliencyPoliciesRequest$policyName' => 'The name of the policy
', 'LogicalResourceId$resourceGroupName' => 'The name of the resource group that this resource belongs to.
', 'PhysicalResource$parentResourceName' => 'Name of the parent resource.
', 'PhysicalResource$resourceName' => 'The name of the resource.
', 'RecommendationTemplate$name' => 'Name for the recommendation template.
', 'ResiliencyPolicy$policyName' => 'The name of the policy
', 'ResourceMapping$appRegistryAppName' => 'The name of the application this resource is mapped to.
', 'ResourceMapping$resourceGroupName' => 'Name of the resource group that the resource is mapped to.
', 'ResourceMapping$resourceName' => 'Name of the resource that the resource is mapped to.
', 'StartAppAssessmentRequest$assessmentName' => 'The name for the assessment.
', 'UpdateAppVersionResourceRequest$resourceName' => 'Name of the resource.
', 'UpdateResiliencyPolicyRequest$policyName' => 'The name of the policy
', ], ], 'EntityNameList' => [ 'base' => NULL, 'refs' => [ 'RemoveDraftAppVersionResourceMappingsRequest$appRegistryAppNames' => 'The names of the registered applications you want to remove from the resource mappings.
', 'RemoveDraftAppVersionResourceMappingsRequest$resourceGroupNames' => 'The names of the resource groups you want to remove from the resource mappings.
', 'RemoveDraftAppVersionResourceMappingsRequest$resourceNames' => 'The names of the resources you want to remove from the resource mappings.
', ], ], 'EntityVersion' => [ 'base' => NULL, 'refs' => [ 'AddDraftAppVersionResourceMappingsResponse$appVersion' => 'The version of the application.
', 'AppAssessment$appVersion' => 'Version of an application.
', 'AppAssessment$versionName' => 'Version name of the published application.
', 'AppAssessmentSummary$appVersion' => 'Version of an application.
', 'AppAssessmentSummary$versionName' => 'Name of an application version.
', 'AppVersionSummary$appVersion' => 'Version of an application.
', 'AppVersionSummary$versionName' => 'Name of the application version.
', 'CreateAppVersionAppComponentResponse$appVersion' => 'Resilience Hub application version.
', 'CreateAppVersionResourceResponse$appVersion' => 'Resilience Hub application version.
', 'DeleteAppVersionAppComponentResponse$appVersion' => 'Resilience Hub application version.
', 'DeleteAppVersionResourceResponse$appVersion' => 'Resilience Hub application version.
', 'DescribeAppVersionAppComponentRequest$appVersion' => 'Resilience Hub application version.
', 'DescribeAppVersionAppComponentResponse$appVersion' => 'Resilience Hub application version.
', 'DescribeAppVersionRequest$appVersion' => 'Resilience Hub application version.
', 'DescribeAppVersionResourceRequest$appVersion' => 'Resilience Hub application version.
', 'DescribeAppVersionResourceResponse$appVersion' => 'Resilience Hub application version.
', 'DescribeAppVersionResourcesResolutionStatusRequest$appVersion' => 'The version of the application.
', 'DescribeAppVersionResourcesResolutionStatusResponse$appVersion' => 'The version of the application.
', 'DescribeAppVersionResponse$appVersion' => 'Resilience Hub application version.
', 'DescribeAppVersionTemplateRequest$appVersion' => 'The version of the application.
', 'DescribeAppVersionTemplateResponse$appVersion' => 'The version of the application.
', 'DescribeDraftAppVersionResourcesImportStatusResponse$appVersion' => 'The version of the application.
', 'ImportResourcesToDraftAppVersionResponse$appVersion' => 'The version of the application.
', 'ListAppInputSourcesRequest$appVersion' => 'Resilience Hub application version.
', 'ListAppVersionAppComponentsRequest$appVersion' => 'Version of the Application Component.
', 'ListAppVersionAppComponentsResponse$appVersion' => 'Resilience Hub application version.
', 'ListAppVersionResourceMappingsRequest$appVersion' => 'The version of the application.
', 'ListAppVersionResourcesRequest$appVersion' => 'The version of the application.
', 'ListUnsupportedAppVersionResourcesRequest$appVersion' => 'The version of the application.
', 'PublishAppVersionRequest$versionName' => 'Name of the application version.
', 'PublishAppVersionResponse$appVersion' => 'The version of the application.
', 'PublishAppVersionResponse$versionName' => 'Name of the application version.
', 'PutDraftAppVersionTemplateResponse$appVersion' => 'The version of the application.
', 'RemoveDraftAppVersionResourceMappingsResponse$appVersion' => 'The version of the application.
', 'ResolveAppVersionResourcesRequest$appVersion' => 'The version of the application.
', 'ResolveAppVersionResourcesResponse$appVersion' => 'The version of the application.
', 'StartAppAssessmentRequest$appVersion' => 'The version of the application.
', 'UpdateAppVersionAppComponentResponse$appVersion' => 'Resilience Hub application version.
', 'UpdateAppVersionResourceResponse$appVersion' => 'Resilience Hub application version.
', 'UpdateAppVersionResponse$appVersion' => 'Resilience Hub application version.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BatchUpdateRecommendationStatusFailedEntry$errorMessage' => 'Indicates the error that occurred while excluding an operational recommendation.
', 'ResourceError$reason' => 'This is the error message.
', ], ], 'EstimatedCostTier' => [ 'base' => NULL, 'refs' => [ 'ResiliencyPolicy$estimatedCostTier' => 'Specifies the estimated cost tier of the resiliency policy.
', ], ], 'EventSubscription' => [ 'base' => 'Indicates an event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.
', 'refs' => [ 'EventSubscriptionList$member' => NULL, ], ], 'EventSubscriptionList' => [ 'base' => NULL, 'refs' => [ 'App$eventSubscriptions' => 'The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.
', 'CreateAppRequest$eventSubscriptions' => 'The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification.
', 'UpdateAppRequest$eventSubscriptions' => 'The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.
', ], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'EventSubscription$eventType' => 'The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected (DriftDetected) and Scheduled assessment failure (ScheduledAssessmentFailure) events.
Indicates the reason for excluding an operational recommendation.
', 'RecommendationItem$excludeReason' => 'Indicates the reason for excluding an operational recommendation.
', 'UpdateRecommendationStatusRequestEntry$excludeReason' => 'Indicates the reason for excluding an operational recommendation.
', ], ], 'FailurePolicy' => [ 'base' => 'Defines a failure policy.
', 'refs' => [ 'DisruptionPolicy$value' => NULL, ], ], 'HaArchitecture' => [ 'base' => NULL, 'refs' => [ 'ConfigRecommendation$haArchitecture' => 'The architecture type.
', ], ], 'IamRoleArn' => [ 'base' => NULL, 'refs' => [ 'IamRoleArnList$member' => NULL, ], ], 'IamRoleArnList' => [ 'base' => NULL, 'refs' => [ 'PermissionModel$crossAccountRoleArns' => 'Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.
These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.
These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the primary account.
Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.
You must have iam:passRole permission for this role while creating or updating the application.
The number of resources.
', ], ], 'InternalServerException' => [ 'base' => 'This exception occurs when there is an internal failure in the Resilience Hub service.
', 'refs' => [], ], 'ListAlarmRecommendationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAlarmRecommendationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppAssessmentComplianceDriftsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppAssessmentComplianceDriftsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppAssessmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppAssessmentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppComponentCompliancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppComponentCompliancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppComponentRecommendationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppComponentRecommendationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInputSourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInputSourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionAppComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionAppComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionResourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionResourceMappingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRecommendationTemplatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRecommendationTemplatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResiliencyPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResiliencyPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSopRecommendationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSopRecommendationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSuggestedResiliencyPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSuggestedResiliencyPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTestRecommendationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTestRecommendationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUnsupportedAppVersionResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUnsupportedAppVersionResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogicalResourceId' => [ 'base' => 'Defines a logical resource identifier.
', 'refs' => [ 'CreateAppVersionResourceRequest$logicalResourceId' => 'Logical identifier of the resource.
', 'DeleteAppVersionResourceRequest$logicalResourceId' => 'Logical identifier of the resource.
', 'DescribeAppVersionResourceRequest$logicalResourceId' => 'Logical identifier of the resource.
', 'PhysicalResource$logicalResourceId' => 'Logical identifier of the resource.
', 'UnsupportedResource$logicalResourceId' => 'Logical resource identifier for the unsupported resource.
', 'UpdateAppVersionResourceRequest$logicalResourceId' => 'Logical identifier of the resource.
', ], ], 'LongOptional' => [ 'base' => NULL, 'refs' => [ 'AppVersionSummary$identifier' => 'Identifier of the application version.
', 'PublishAppVersionResponse$identifier' => 'Identifier of the application version.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAlarmRecommendationsRequest$maxResults' => 'Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Indicates the maximum number of applications requested.
', 'ListAppAssessmentsRequest$maxResults' => 'Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of input sources to be displayed per Resilience Hub application.
', 'ListAppVersionAppComponentsRequest$maxResults' => 'Maximum number of Application Components to be displayed per Resilience Hub application version.
', 'ListAppVersionResourceMappingsRequest$maxResults' => 'Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Null, or the token from a previous call to get the next set of results.
', 'ListAlarmRecommendationsResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListAppAssessmentComplianceDriftsRequest$nextToken' => 'Indicates the unique token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
', 'ListAppAssessmentComplianceDriftsResponse$nextToken' => 'Token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
', 'ListAppAssessmentsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppAssessmentsResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListAppComponentCompliancesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppComponentCompliancesResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListAppComponentRecommendationsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppComponentRecommendationsResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListAppInputSourcesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppInputSourcesResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListAppVersionAppComponentsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppVersionAppComponentsResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListAppVersionResourceMappingsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppVersionResourceMappingsResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListAppVersionResourcesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppVersionResourcesResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListAppVersionsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppVersionsResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListAppsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListAppsResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListRecommendationTemplatesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListRecommendationTemplatesResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListResiliencyPoliciesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListResiliencyPoliciesResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListSopRecommendationsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListSopRecommendationsResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListSuggestedResiliencyPoliciesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListSuggestedResiliencyPoliciesResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListTestRecommendationsRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListTestRecommendationsResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', 'ListUnsupportedAppVersionResourcesRequest$nextToken' => 'Null, or the token from a previous call to get the next set of results.
', 'ListUnsupportedAppVersionResourcesResponse$nextToken' => 'Token for the next set of results, or null if there are no more results.
', ], ], 'PermissionModel' => [ 'base' => 'Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.
', 'refs' => [ 'App$permissionModel' => 'Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.
', 'CreateAppRequest$permissionModel' => 'Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.
', 'UpdateAppRequest$permissionModel' => 'Defines the roles and credentials that Resilience Hub would use while creating an application, importing its resources, and running an assessment.
', ], ], 'PermissionModelType' => [ 'base' => NULL, 'refs' => [ 'PermissionModel$type' => 'Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user.
', ], ], 'PhysicalIdentifierType' => [ 'base' => NULL, 'refs' => [ 'PhysicalResourceId$type' => 'Specifies the type of physical resource identifier.
The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:
AWS::ECS::Service
AWS::EFS::FileSystem
AWS::ElasticLoadBalancingV2::LoadBalancer
AWS::Lambda::Function
AWS::SNS::Topic
The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:
AWS::ApiGateway::RestApi
AWS::ApiGatewayV2::Api
AWS::AutoScaling::AutoScalingGroup
AWS::DocDB::DBCluster
AWS::DocDB::DBGlobalCluster
AWS::DocDB::DBInstance
AWS::DynamoDB::GlobalTable
AWS::DynamoDB::Table
AWS::EC2::EC2Fleet
AWS::EC2::Instance
AWS::EC2::NatGateway
AWS::EC2::Volume
AWS::ElasticLoadBalancing::LoadBalancer
AWS::RDS::DBCluster
AWS::RDS::DBInstance
AWS::RDS::GlobalCluster
AWS::Route53::RecordSet
AWS::S3::Bucket
AWS::SQS::Queue
Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or an Resilience Hub-native identifier.
', 'refs' => [ 'CreateAppVersionResourceResponse$physicalResource' => 'Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
', 'DeleteAppVersionResourceResponse$physicalResource' => 'Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
', 'DescribeAppVersionResourceResponse$physicalResource' => 'Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
', 'PhysicalResourceList$member' => NULL, 'UpdateAppVersionResourceResponse$physicalResource' => 'Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
', ], ], 'PhysicalResourceId' => [ 'base' => 'Defines a physical resource identifier.
', 'refs' => [ 'PhysicalResource$physicalResourceId' => 'Identifier of the physical resource.
', 'ResourceMapping$physicalResourceId' => 'Identifier of the physical resource.
', 'UnsupportedResource$physicalResourceId' => 'Physical resource identifier for the unsupported resource.
', ], ], 'PhysicalResourceList' => [ 'base' => NULL, 'refs' => [ 'ListAppVersionResourcesResponse$physicalResources' => 'The physical resources in the application version.
', ], ], 'PublishAppVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PublishAppVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutDraftAppVersionTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDraftAppVersionTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RecommendationCompliance' => [ 'base' => NULL, 'refs' => [ 'ConfigRecommendation$recommendationCompliance' => 'The expected compliance against the resiliency policy after applying the configuration change.
', ], ], 'RecommendationComplianceStatus' => [ 'base' => NULL, 'refs' => [ 'ComponentRecommendation$recommendationStatus' => 'Status of the recommendation.
', ], ], 'RecommendationDisruptionCompliance' => [ 'base' => 'Defines a disruption compliance recommendation.
', 'refs' => [ 'RecommendationCompliance$value' => NULL, ], ], 'RecommendationIdList' => [ 'base' => NULL, 'refs' => [ 'CreateRecommendationTemplateRequest$recommendationIds' => 'Identifiers for the recommendations used to create a recommendation template.
', 'RecommendationTemplate$recommendationIds' => 'Identifiers for the recommendations used in the recommendation template.
', ], ], 'RecommendationItem' => [ 'base' => 'Defines a recommendation.
', 'refs' => [ 'RecommendationItemList$member' => NULL, ], ], 'RecommendationItemList' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$items' => 'List of CloudWatch alarm recommendations.
', 'SopRecommendation$items' => 'The recommendation items.
', 'TestRecommendation$items' => 'The test recommendation items.
', ], ], 'RecommendationTemplate' => [ 'base' => 'Defines a recommendation template created with the CreateRecommendationTemplate action.
', 'refs' => [ 'CreateRecommendationTemplateResponse$recommendationTemplate' => 'The newly created recommendation template, returned as an object. This object includes the template\'s name, format, status, tags, Amazon S3 bucket location, and more.
', 'RecommendationTemplateList$member' => NULL, ], ], 'RecommendationTemplateList' => [ 'base' => NULL, 'refs' => [ 'ListRecommendationTemplatesResponse$recommendationTemplates' => 'The recommendation templates for the Resilience Hub applications.
', ], ], 'RecommendationTemplateStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteRecommendationTemplateResponse$status' => 'Status of the action.
', 'RecommendationTemplate$status' => 'Status of the action.
', 'RecommendationTemplateStatusList$member' => NULL, ], ], 'RecommendationTemplateStatusList' => [ 'base' => NULL, 'refs' => [ 'ListRecommendationTemplatesRequest$status' => 'Status of the action.
', ], ], 'RemoveDraftAppVersionResourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveDraftAppVersionResourceMappingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenderRecommendationType' => [ 'base' => NULL, 'refs' => [ 'RenderRecommendationTypeList$member' => NULL, ], ], 'RenderRecommendationTypeList' => [ 'base' => NULL, 'refs' => [ 'CreateRecommendationTemplateRequest$recommendationTypes' => 'An array of strings that specify the recommendation template type or types.
The template is an AlarmRecommendation template.
The template is a SopRecommendation template.
The template is a TestRecommendation template.
An array of strings that specify the recommendation template type or types.
The template is an AlarmRecommendation template.
The template is a SopRecommendation template.
The template is a TestRecommendation template.
The resiliency policies for the Resilience Hub applications.
', 'ListSuggestedResiliencyPoliciesResponse$resiliencyPolicies' => 'The suggested resiliency policies for the Resilience Hub applications.
', ], ], 'ResiliencyPolicy' => [ 'base' => 'Defines a resiliency policy.
', 'refs' => [ 'AppAssessment$policy' => 'Resiliency policy of an application.
', 'CreateResiliencyPolicyResponse$policy' => 'The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
', 'DescribeResiliencyPolicyResponse$policy' => 'Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.
', 'ResiliencyPolicies$member' => NULL, 'UpdateResiliencyPolicyResponse$policy' => 'The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
', ], ], 'ResiliencyPolicyTier' => [ 'base' => NULL, 'refs' => [ 'CreateResiliencyPolicyRequest$tier' => 'The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
The overall resiliency score, returned as an object that includes the disruption score and outage score.
', 'refs' => [ 'AppAssessment$resiliencyScore' => 'Current resiliency score for an application.
', 'AppComponentCompliance$resiliencyScore' => 'The current resiliency score for the application.
', ], ], 'ResolveAppVersionResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResolveAppVersionResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceError' => [ 'base' => 'Defines application resource errors.
', 'refs' => [ 'ResourceErrorList$member' => NULL, ], ], 'ResourceErrorList' => [ 'base' => NULL, 'refs' => [ 'ResourceErrorsDetails$resourceErrors' => 'A list of errors retrieving an application\'s resources.
', ], ], 'ResourceErrorsDetails' => [ 'base' => 'A list of errors retrieving an application\'s resources.
', 'refs' => [ 'AppAssessment$resourceErrorsDetails' => 'A resource error object containing a list of errors retrieving an application\'s resources.
', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ConflictException$resourceId' => 'The identifier of the resource that the exception applies to.
', 'ResourceNotFoundException$resourceId' => 'The identifier of the resource that the exception applies to.
', ], ], 'ResourceImportStatusType' => [ 'base' => NULL, 'refs' => [ 'DescribeDraftAppVersionResourcesImportStatusResponse$status' => 'Status of the action.
', 'ImportResourcesToDraftAppVersionResponse$status' => 'Status of the action.
', ], ], 'ResourceImportStrategyType' => [ 'base' => NULL, 'refs' => [ 'ImportResourcesToDraftAppVersionRequest$importStrategy' => 'The import strategy you would like to set to import resources into Resilience Hub application.
', ], ], 'ResourceMapping' => [ 'base' => 'Defines a resource mapping.
', 'refs' => [ 'ResourceMappingList$member' => NULL, ], ], 'ResourceMappingList' => [ 'base' => NULL, 'refs' => [ 'AddDraftAppVersionResourceMappingsRequest$resourceMappings' => 'Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
List of sources that are used to map a logical resource from the template to a physical resource. You can use sources such as CloudFormation, Terraform state files, AppRegistry applications, or Amazon EKS.
', 'ListAppVersionResourceMappingsResponse$resourceMappings' => 'Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
The resource type of the input source.
', 'ResourceMapping$mappingType' => 'Specifies the type of resource mapping.
The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.
The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.
The resource is mapped to another resource. The name of the resource is contained in the resourceName property.
The resource is mapped to Resource Groups. The name of the resource group is contained in the resourceGroupName property.
This exception occurs when the specified resource could not be found.
', 'refs' => [], ], 'ResourceResolutionStatusType' => [ 'base' => NULL, 'refs' => [ 'DescribeAppVersionResourcesResolutionStatusResponse$status' => 'Status of the action.
', 'ResolveAppVersionResourcesResponse$status' => 'Status of the action.
', ], ], 'ResourceSourceType' => [ 'base' => NULL, 'refs' => [ 'PhysicalResource$sourceType' => 'Type of input source.
', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ConflictException$resourceType' => 'The type of the resource that the exception applies to.
', 'ResourceNotFoundException$resourceType' => 'The type of the resource that the exception applies to.
', ], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'ThrottlingException$retryAfterSeconds' => 'The number of seconds to wait before retrying the operation.
', ], ], 'S3Location' => [ 'base' => 'The location of the Amazon S3 bucket.
', 'refs' => [ 'RecommendationTemplate$templatesLocation' => 'The file location of the template.
', ], ], 'S3Url' => [ 'base' => NULL, 'refs' => [ 'TerraformSource$s3StateFileUrl' => 'The URL of the Terraform s3 state file you need to import.
', ], ], 'Seconds' => [ 'base' => NULL, 'refs' => [ 'DisruptionCompliance$achievableRpoInSecs' => 'The Recovery Point Objective (RPO) that is achievable, in seconds.
', 'DisruptionCompliance$achievableRtoInSecs' => 'The Recovery Time Objective (RTO) that is achievable, in seconds
', 'DisruptionCompliance$currentRpoInSecs' => 'The current RPO, in seconds.
', 'DisruptionCompliance$currentRtoInSecs' => 'The current RTO, in seconds.
', 'FailurePolicy$rpoInSecs' => 'The Recovery Point Objective (RPO), in seconds.
', 'FailurePolicy$rtoInSecs' => 'The Recovery Time Objective (RTO), in seconds.
', 'RecommendationDisruptionCompliance$expectedRpoInSecs' => 'The expected RPO after applying the recommended configuration change.
', 'RecommendationDisruptionCompliance$expectedRtoInSecs' => 'The expected RTO after applying the recommended configuration change.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
', 'refs' => [], ], 'SopRecommendation' => [ 'base' => 'Defines a standard operating procedure (SOP) recommendation.
', 'refs' => [ 'SopRecommendationList$member' => NULL, ], ], 'SopRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ListSopRecommendationsResponse$sopRecommendations' => 'The standard operating procedure (SOP) recommendations for the Resilience Hub applications.
', ], ], 'SopServiceType' => [ 'base' => NULL, 'refs' => [ 'SopRecommendation$serviceType' => 'The service type.
', ], ], 'SpecReferenceId' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$referenceId' => 'Reference identifier of the alarm recommendation.
', 'BatchUpdateRecommendationStatusSuccessfulEntry$referenceId' => 'Reference identifier of the operational recommendation.
', 'ConfigRecommendation$referenceId' => 'Reference identifier for the recommendation configuration.
', 'SopRecommendation$referenceId' => 'Reference identifier for the SOP recommendation.
', 'TestRecommendation$referenceId' => 'Reference identifier for the test recommendation.
', 'UpdateRecommendationStatusRequestEntry$referenceId' => 'Reference identifier of the operational recommendation item.
', ], ], 'StartAppAssessmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAppAssessmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'String1024' => [ 'base' => NULL, 'refs' => [ 'AdditionalInfoValueList$member' => NULL, ], ], 'String128WithoutWhitespace' => [ 'base' => NULL, 'refs' => [ 'AdditionalInfoMap$key' => NULL, ], ], 'String2048' => [ 'base' => NULL, 'refs' => [ 'CreateAppVersionResourceRequest$physicalResourceId' => 'Physical identifier of the resource.
', 'DeleteAppVersionResourceRequest$physicalResourceId' => 'Physical identifier of the resource.
', 'DescribeAppVersionResourceRequest$physicalResourceId' => 'Physical identifier of the resource.
', 'UpdateAppVersionResourceRequest$physicalResourceId' => 'Physical identifier of the resource.
', ], ], 'String255' => [ 'base' => NULL, 'refs' => [ 'AppComponent$id' => 'Identifier of the Application Component.
', 'AppComponent$name' => 'Name of the Application Component.
', 'AppComponent$type' => 'The type of Application Component.
', 'AppComponentNameList$member' => NULL, 'AppInputSource$sourceName' => 'The name of the input source.
', 'BatchUpdateRecommendationStatusFailedEntry$entryId' => 'An identifier of an entry in this batch that is used to communicate the result.
The entryIds of a batch request need to be unique within a request.
An identifier for an entry in this batch that is used to communicate the result.
The entryIds of a batch request need to be unique within a request.
Assessment identifier that is associated with this drift item.
', 'ComplianceDrift$appId' => 'Identifier of your application.
', 'ComplianceDrift$appVersion' => 'Published version of your application on which drift was detected.
', 'ComplianceDrift$entityId' => 'Identifier of an entity in which drift was detected. For compliance drift, the entity ID can be either application ID or the AppComponent ID.
', 'ComplianceDrift$entityType' => 'The type of entity in which drift was detected. For compliance drifts, Resilience Hub supports AWS::ResilienceHub::AppComponent and AWS::ResilienceHub::Application.
Assessment identifier of a previous assessment of the same application version. Resilience Hub uses the previous assessment (associated with the reference identifier) to compare the compliance with the current assessment to identify drifts.
', 'CreateAppVersionAppComponentRequest$id' => 'Identifier of the Application Component.
', 'CreateAppVersionAppComponentRequest$name' => 'Name of the Application Component.
', 'CreateAppVersionAppComponentRequest$type' => 'Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
', 'CreateAppVersionResourceRequest$resourceType' => 'Type of resource.
', 'DeleteAppVersionAppComponentRequest$id' => 'Identifier of the Application Component.
', 'DescribeAppVersionAppComponentRequest$id' => 'Identifier of the Application Component.
', 'DescribeAppVersionResourcesResolutionStatusRequest$resolutionId' => 'The identifier for a specific resolution.
', 'DescribeAppVersionResourcesResolutionStatusResponse$resolutionId' => 'The identifier for a specific resolution.
', 'EventSubscription$name' => 'Unique name to identify an event subscription.
', 'ListAppVersionResourcesRequest$resolutionId' => 'The identifier for a specific resolution.
', 'ListAppVersionResourcesResponse$resolutionId' => 'The ID for a specific resolution.
', 'ListUnsupportedAppVersionResourcesRequest$resolutionId' => 'The identifier for a specific resolution.
', 'ListUnsupportedAppVersionResourcesResponse$resolutionId' => 'The identifier for a specific resolution.
', 'LogicalResourceId$eksSourceName' => 'Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Identifier of the resource.
', 'LogicalResourceId$logicalStackName' => 'The name of the CloudFormation stack this resource belongs to.
', 'LogicalResourceId$terraformSourceName' => 'The name of the Terraform S3 state file this resource belongs to.
', 'PhysicalResource$resourceType' => 'The type of resource.
', 'PhysicalResourceId$identifier' => 'Identifier of the physical resource.
', 'ResolveAppVersionResourcesResponse$resolutionId' => 'The identifier for a specific resolution.
', 'ResourceError$logicalResourceId' => 'Identifier of the logical resource.
', 'ResourceError$physicalResourceId' => 'Identifier of the physical resource.
', 'ResourceMapping$eksSourceName' => 'Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
The name of the CloudFormation stack this resource is mapped to.
', 'ResourceMapping$terraformSourceName' => 'The short name of the Terraform source.
', 'String255List$member' => NULL, 'UnsupportedResource$resourceType' => 'The type of resource.
', 'UnsupportedResource$unsupportedResourceStatus' => 'The status of the unsupported resource.
', 'UpdateAppVersionAppComponentRequest$id' => 'Identifier of the Application Component.
', 'UpdateAppVersionAppComponentRequest$name' => 'Name of the Application Component.
', 'UpdateAppVersionAppComponentRequest$type' => 'Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
', 'UpdateAppVersionResourceRequest$resourceType' => 'Type of resource.
', 'UpdateRecommendationStatusRequestEntry$entryId' => 'An identifier for an entry in this batch that is used to communicate the result.
The entryIds of a batch request need to be unique within a request.
The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from the resource mappings.
This parameter accepts values in "eks-cluster/namespace" format.
The names of the CloudFormation stacks you want to remove from the resource mappings.
', 'RemoveDraftAppVersionResourceMappingsRequest$terraformSourceNames' => 'The names of the Terraform sources you want to remove from the resource mappings.
', ], ], 'String500' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'AlarmRecommendation$name' => 'Name of the alarm recommendation.
', 'AlarmRecommendation$prerequisite' => 'The prerequisite for the alarm recommendation.
', 'AlarmReferenceIdList$member' => NULL, 'AppAssessment$message' => 'Error or warning message from the assessment execution
', 'AppAssessmentSummary$message' => 'Message from the assessment run.
', 'AppComponentCompliance$message' => 'The compliance message.
', 'ConflictException$message' => NULL, 'DescribeAppVersionResourcesResolutionStatusResponse$errorMessage' => 'The returned error message for the request.
', 'DescribeDraftAppVersionResourcesImportStatusResponse$errorMessage' => 'The returned error message for the request.
', 'DisruptionCompliance$message' => 'The disruption compliance message.
', 'DisruptionCompliance$rpoDescription' => 'The RPO description.
', 'DisruptionCompliance$rpoReferenceId' => 'Reference identifier of the RPO .
', 'DisruptionCompliance$rtoDescription' => 'The RTO description.
', 'DisruptionCompliance$rtoReferenceId' => 'Reference identifier of the RTO.
', 'InternalServerException$message' => NULL, 'RecommendationDisruptionCompliance$expectedRpoDescription' => 'The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.
', 'RecommendationDisruptionCompliance$expectedRtoDescription' => 'The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.
', 'RecommendationItem$resourceId' => 'Identifier of the resource.
', 'RecommendationTemplate$message' => 'Message for the recommendation template.
', 'ResourceNotFoundException$message' => NULL, 'S3Location$bucket' => 'The name of the Amazon S3 bucket.
', 'S3Location$prefix' => 'The prefix for the Amazon S3 bucket.
', 'ServiceQuotaExceededException$message' => NULL, 'SopRecommendation$description' => 'Description of the SOP recommendation.
', 'SopRecommendation$prerequisite' => 'Prerequisite for the SOP recommendation.
', 'TestRecommendation$description' => 'Description for the test recommendation.
', 'TestRecommendation$prerequisite' => 'Prerequisite of the test recommendation.
', 'ThrottlingException$message' => NULL, 'UpdateRecommendationStatusItem$resourceId' => 'Resource identifier of the operational recommendation item.
', 'ValidationException$message' => NULL, ], ], 'SuggestedChangesList' => [ 'base' => NULL, 'refs' => [ 'ConfigRecommendation$suggestedChanges' => 'List of the suggested configuration changes.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The keys of the tags you want to remove.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'App$tags' => 'Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'AppAssessment$tags' => 'Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'CreateAppRequest$tags' => 'Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'CreateRecommendationTemplateRequest$tags' => 'Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'CreateResiliencyPolicyRequest$tags' => 'Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'ListTagsForResourceResponse$tags' => 'Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'RecommendationTemplate$tags' => 'Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'ResiliencyPolicy$tags' => 'Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'StartAppAssessmentRequest$tags' => 'Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
', 'TagResourceRequest$tags' => 'The tags to assign to the resource. Each tag consists of a key/value pair.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'TemplateFormat' => [ 'base' => NULL, 'refs' => [ 'CreateRecommendationTemplateRequest$format' => 'The format for the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
Format of the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
The Terraform s3 state file you need to import.
', 'refs' => [ 'AppInputSource$terraformSource' => 'The name of the Terraform s3 state file.
', 'DeleteAppInputSourceRequest$terraformSource' => 'The imported Terraform s3 state file you want to remove from the Resilience Hub application.
', 'TerraformSourceList$member' => NULL, ], ], 'TerraformSourceList' => [ 'base' => NULL, 'refs' => [ 'ImportResourcesToDraftAppVersionRequest$terraformSources' => 'A list of terraform file s3 URLs you need to import.
', 'ImportResourcesToDraftAppVersionResponse$terraformSources' => 'A list of terraform file s3 URLs you have imported.
', ], ], 'TestRecommendation' => [ 'base' => 'Defines a test recommendation.
', 'refs' => [ 'TestRecommendationList$member' => NULL, ], ], 'TestRecommendationList' => [ 'base' => NULL, 'refs' => [ 'ListTestRecommendationsResponse$testRecommendations' => 'The test recommendations for the Resilience Hub application.
', ], ], 'TestRisk' => [ 'base' => NULL, 'refs' => [ 'TestRecommendation$risk' => 'Level of risk for this test recommendation.
', ], ], 'TestType' => [ 'base' => NULL, 'refs' => [ 'TestRecommendation$type' => 'Type of test recommendation.
', ], ], 'ThrottlingException' => [ 'base' => 'This exception occurs when you have exceeded the limit on the number of requests per second.
', 'refs' => [], ], 'TimeStamp' => [ 'base' => NULL, 'refs' => [ 'App$creationTime' => 'Timestamp for when the app was created.
', 'App$lastAppComplianceEvaluationTime' => 'Timestamp for the most recent compliance evaluation.
', 'App$lastDriftEvaluationTime' => 'Indicates the last time that a drift was evaluated.
', 'App$lastResiliencyScoreEvaluationTime' => 'Timestamp for the most recent resiliency score evaluation.
', 'AppAssessment$endTime' => 'End time for the action.
', 'AppAssessment$startTime' => 'Starting time for the action.
', 'AppAssessmentSummary$endTime' => 'End time for the action.
', 'AppAssessmentSummary$startTime' => 'Starting time for the action.
', 'AppSummary$creationTime' => 'The timestamp for when the app was created.
', 'AppVersionSummary$creationTime' => 'Creation time of the application version.
', 'DescribeDraftAppVersionResourcesImportStatusResponse$statusChangeTime' => 'The timestamp for when the status last changed.
', 'ListAppVersionsRequest$endTime' => 'Upper limit of the time range to filter the application versions.
', 'ListAppVersionsRequest$startTime' => 'Lower limit of the time range to filter the application versions.
', 'RecommendationTemplate$endTime' => 'The end time for the action.
', 'RecommendationTemplate$startTime' => 'The start time for the action.
', 'ResiliencyPolicy$creationTime' => 'The timestamp for when the resiliency policy was created.
', ], ], 'UnsupportedResource' => [ 'base' => 'Defines a resource that is not supported by Resilience Hub.
', 'refs' => [ 'UnsupportedResourceList$member' => NULL, ], ], 'UnsupportedResourceList' => [ 'base' => NULL, 'refs' => [ 'ListUnsupportedAppVersionResourcesResponse$unsupportedResources' => 'The unsupported resources for the application.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionAppComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionAppComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRecommendationStatusItem' => [ 'base' => 'Defines the operational recommendation item that needs a status update.
', 'refs' => [ 'BatchUpdateRecommendationStatusSuccessfulEntry$item' => 'The operational recommendation item.
', 'UpdateRecommendationStatusRequestEntry$item' => 'The operational recommendation item.
', ], ], 'UpdateRecommendationStatusRequestEntries' => [ 'base' => NULL, 'refs' => [ 'BatchUpdateRecommendationStatusRequest$requestEntries' => 'Defines the list of operational recommendations that need to be included or excluded.
', ], ], 'UpdateRecommendationStatusRequestEntry' => [ 'base' => 'Defines the operational recommendation item that is to be included or excluded.
', 'refs' => [ 'UpdateRecommendationStatusRequestEntries$member' => NULL, ], ], 'UpdateResiliencyPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResiliencyPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Uuid' => [ 'base' => NULL, 'refs' => [ 'AlarmRecommendation$recommendationId' => 'Identifier of the alarm recommendation.
', 'RecommendationIdList$member' => NULL, 'SopRecommendation$recommendationId' => 'Identifier for the SOP recommendation.
', 'TestRecommendation$recommendationId' => 'Identifier for the test recommendation.
', ], ], 'ValidationException' => [ 'base' => 'This exception occurs when a request is not valid.
', 'refs' => [], ], ],]; diff --git a/src/data/resiliencehub/2020-04-30/paginators-1.json b/src/data/resiliencehub/2020-04-30/paginators-1.json index ce7bf05b48..6d700c4667 100644 --- a/src/data/resiliencehub/2020-04-30/paginators-1.json +++ b/src/data/resiliencehub/2020-04-30/paginators-1.json @@ -5,6 +5,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListAppAssessmentComplianceDrifts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListAppAssessments": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/src/data/resiliencehub/2020-04-30/paginators-1.json.php b/src/data/resiliencehub/2020-04-30/paginators-1.json.php index f2f3c17f20..8a858ef1f8 100644 --- a/src/data/resiliencehub/2020-04-30/paginators-1.json.php +++ b/src/data/resiliencehub/2020-04-30/paginators-1.json.php @@ -1,3 +1,3 @@ [ 'ListAlarmRecommendations' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppAssessments' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppComponentCompliances' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppComponentRecommendations' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppInputSources' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppVersionAppComponents' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppVersionResourceMappings' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppVersionResources' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppVersions' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListApps' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListRecommendationTemplates' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListResiliencyPolicies' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListSopRecommendations' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListSuggestedResiliencyPolicies' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListTestRecommendations' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListUnsupportedAppVersionResources' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], ],]; +return [ 'pagination' => [ 'ListAlarmRecommendations' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppAssessmentComplianceDrifts' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppAssessments' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppComponentCompliances' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppComponentRecommendations' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppInputSources' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppVersionAppComponents' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppVersionResourceMappings' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppVersionResources' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListAppVersions' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListApps' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListRecommendationTemplates' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListResiliencyPolicies' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListSopRecommendations' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListSuggestedResiliencyPolicies' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListTestRecommendations' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], 'ListUnsupportedAppVersionResources' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', ], ],]; diff --git a/src/data/sagemaker/2017-07-24/api-2.json b/src/data/sagemaker/2017-07-24/api-2.json index c7618c2b9a..81531c4a0a 100644 --- a/src/data/sagemaker/2017-07-24/api-2.json +++ b/src/data/sagemaker/2017-07-24/api-2.json @@ -1955,6 +1955,18 @@ "input":{"shape":"GetSagemakerServicecatalogPortfolioStatusInput"}, "output":{"shape":"GetSagemakerServicecatalogPortfolioStatusOutput"} }, + "GetScalingConfigurationRecommendation":{ + "name":"GetScalingConfigurationRecommendation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetScalingConfigurationRecommendationRequest"}, + "output":{"shape":"GetScalingConfigurationRecommendationResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "GetSearchSuggestions":{ "name":"GetSearchSuggestions", "http":{ @@ -6984,6 +6996,14 @@ "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}" }, + "CustomizedMetricSpecification":{ + "type":"structure", + "members":{ + "MetricName":{"shape":"String"}, + "Namespace":{"shape":"String"}, + "Statistic":{"shape":"Statistic"} + } + }, "DataCaptureConfig":{ "type":"structure", "required":[ @@ -9790,6 +9810,7 @@ "Delete_Failed" ] }, + "Double":{"type":"double"}, "DoubleParameterValue":{"type":"double"}, "DriftCheckBaselines":{ "type":"structure", @@ -9829,6 +9850,16 @@ "Constraints":{"shape":"MetricsSource"} } }, + "DynamicScalingConfiguration":{ + "type":"structure", + "members":{ + "MinCapacity":{"shape":"Integer"}, + "MaxCapacity":{"shape":"Integer"}, + "ScaleInCooldown":{"shape":"Integer"}, + "ScaleOutCooldown":{"shape":"Integer"}, + "ScalingPolicies":{"shape":"ScalingPolicies"} + } + }, "EMRStepMetadata":{ "type":"structure", "members":{ @@ -11001,6 +11032,29 @@ "Status":{"shape":"SagemakerServicecatalogStatus"} } }, + "GetScalingConfigurationRecommendationRequest":{ + "type":"structure", + "required":["InferenceRecommendationsJobName"], + "members":{ + "InferenceRecommendationsJobName":{"shape":"RecommendationJobName"}, + "RecommendationId":{"shape":"String"}, + "EndpointName":{"shape":"EndpointName"}, + "TargetCpuUtilizationPerCore":{"shape":"UtilizationPercentagePerCore"}, + "ScalingPolicyObjective":{"shape":"ScalingPolicyObjective"} + } + }, + "GetScalingConfigurationRecommendationResponse":{ + "type":"structure", + "members":{ + "InferenceRecommendationsJobName":{"shape":"RecommendationJobName"}, + "RecommendationId":{"shape":"String"}, + "EndpointName":{"shape":"EndpointName"}, + "TargetCpuUtilizationPerCore":{"shape":"UtilizationPercentagePerCore"}, + "ScalingPolicyObjective":{"shape":"ScalingPolicyObjective"}, + "Metric":{"shape":"ScalingPolicyMetric"}, + "DynamicScalingConfiguration":{"shape":"DynamicScalingConfiguration"} + } + }, "GetSearchSuggestionsRequest":{ "type":"structure", "required":["Resource"], @@ -14556,6 +14610,14 @@ "Test" ] }, + "MetricSpecification":{ + "type":"structure", + "members":{ + "Predefined":{"shape":"PredefinedMetricSpecification"}, + "Customized":{"shape":"CustomizedMetricSpecification"} + }, + "union":true + }, "MetricValue":{"type":"float"}, "MetricsSource":{ "type":"structure", @@ -16715,6 +16777,12 @@ "min":1, "pattern":".*" }, + "PredefinedMetricSpecification":{ + "type":"structure", + "members":{ + "PredefinedMetricType":{"shape":"String"} + } + }, "PresignedDomainUrl":{"type":"string"}, "ProbabilityThresholdAttribute":{"type":"double"}, "ProblemType":{ @@ -18430,6 +18498,31 @@ "max":100, "min":0 }, + "ScalingPolicies":{ + "type":"list", + "member":{"shape":"ScalingPolicy"} + }, + "ScalingPolicy":{ + "type":"structure", + "members":{ + "TargetTracking":{"shape":"TargetTrackingScalingPolicyConfiguration"} + }, + "union":true + }, + "ScalingPolicyMetric":{ + "type":"structure", + "members":{ + "InvocationsPerInstance":{"shape":"Integer"}, + "ModelLatency":{"shape":"Integer"} + } + }, + "ScalingPolicyObjective":{ + "type":"structure", + "members":{ + "MinInvocationsPerMinute":{"shape":"Integer"}, + "MaxInvocationsPerMinute":{"shape":"Integer"} + } + }, "ScheduleConfig":{ "type":"structure", "required":["ScheduleExpression"], @@ -19021,6 +19114,16 @@ "PipelineExecutionArn":{"shape":"PipelineExecutionArn"} } }, + "Statistic":{ + "type":"string", + "enum":[ + "Average", + "Minimum", + "Maximum", + "SampleCount", + "Sum" + ] + }, "StatusDetails":{ "type":"string", "max":1024, @@ -19468,6 +19571,13 @@ "LINUX" ] }, + "TargetTrackingScalingPolicyConfiguration":{ + "type":"structure", + "members":{ + "MetricSpecification":{"shape":"MetricSpecification"}, + "TargetValue":{"shape":"Double"} + } + }, "TaskAvailabilityLifetimeInSeconds":{ "type":"integer", "min":60 @@ -21106,6 +21216,11 @@ "type":"float", "min":0.0 }, + "UtilizationPercentagePerCore":{ + "type":"integer", + "max":100, + "min":1 + }, "ValidationFraction":{ "type":"float", "max":1, diff --git a/src/data/sagemaker/2017-07-24/api-2.json.php b/src/data/sagemaker/2017-07-24/api-2.json.php index 9b20c33947..2386e17774 100644 --- a/src/data/sagemaker/2017-07-24/api-2.json.php +++ b/src/data/sagemaker/2017-07-24/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2017-07-24', 'endpointPrefix' => 'api.sagemaker', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'SageMaker', 'serviceFullName' => 'Amazon SageMaker Service', 'serviceId' => 'SageMaker', 'signatureVersion' => 'v4', 'signingName' => 'sagemaker', 'targetPrefix' => 'SageMaker', 'uid' => 'sagemaker-2017-07-24', ], 'operations' => [ 'AddAssociation' => [ 'name' => 'AddAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddAssociationRequest', ], 'output' => [ 'shape' => 'AddAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsInput', ], 'output' => [ 'shape' => 'AddTagsOutput', ], ], 'AssociateTrialComponent' => [ 'name' => 'AssociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateTrialComponentRequest', ], 'output' => [ 'shape' => 'AssociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'BatchDescribeModelPackage' => [ 'name' => 'BatchDescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDescribeModelPackageInput', ], 'output' => [ 'shape' => 'BatchDescribeModelPackageOutput', ], ], 'CreateAction' => [ 'name' => 'CreateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateActionRequest', ], 'output' => [ 'shape' => 'CreateActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAlgorithm' => [ 'name' => 'CreateAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAlgorithmInput', ], 'output' => [ 'shape' => 'CreateAlgorithmOutput', ], ], 'CreateApp' => [ 'name' => 'CreateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppRequest', ], 'output' => [ 'shape' => 'CreateAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateAppImageConfig' => [ 'name' => 'CreateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppImageConfigRequest', ], 'output' => [ 'shape' => 'CreateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateArtifact' => [ 'name' => 'CreateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateArtifactRequest', ], 'output' => [ 'shape' => 'CreateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJob' => [ 'name' => 'CreateAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobRequest', ], 'output' => [ 'shape' => 'CreateAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJobV2' => [ 'name' => 'CreateAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobV2Request', ], 'output' => [ 'shape' => 'CreateAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateCodeRepository' => [ 'name' => 'CreateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCodeRepositoryInput', ], 'output' => [ 'shape' => 'CreateCodeRepositoryOutput', ], ], 'CreateCompilationJob' => [ 'name' => 'CreateCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCompilationJobRequest', ], 'output' => [ 'shape' => 'CreateCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateContext' => [ 'name' => 'CreateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContextRequest', ], 'output' => [ 'shape' => 'CreateContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDataQualityJobDefinition' => [ 'name' => 'CreateDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateDeviceFleet' => [ 'name' => 'CreateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateEdgeDeploymentPlan' => [ 'name' => 'CreateEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'CreateEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgeDeploymentStage' => [ 'name' => 'CreateEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgePackagingJob' => [ 'name' => 'CreateEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgePackagingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpoint' => [ 'name' => 'CreateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointInput', ], 'output' => [ 'shape' => 'CreateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpointConfig' => [ 'name' => 'CreateEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointConfigInput', ], 'output' => [ 'shape' => 'CreateEndpointConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateExperiment' => [ 'name' => 'CreateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateExperimentRequest', ], 'output' => [ 'shape' => 'CreateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFeatureGroup' => [ 'name' => 'CreateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFeatureGroupRequest', ], 'output' => [ 'shape' => 'CreateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFlowDefinition' => [ 'name' => 'CreateFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFlowDefinitionRequest', ], 'output' => [ 'shape' => 'CreateFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHub' => [ 'name' => 'CreateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHubRequest', ], 'output' => [ 'shape' => 'CreateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateHumanTaskUi' => [ 'name' => 'CreateHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHumanTaskUiRequest', ], 'output' => [ 'shape' => 'CreateHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHyperParameterTuningJob' => [ 'name' => 'CreateHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'CreateHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImage' => [ 'name' => 'CreateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageRequest', ], 'output' => [ 'shape' => 'CreateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImageVersion' => [ 'name' => 'CreateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageVersionRequest', ], 'output' => [ 'shape' => 'CreateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateInferenceExperiment' => [ 'name' => 'CreateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'CreateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceRecommendationsJob' => [ 'name' => 'CreateInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'CreateInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateLabelingJob' => [ 'name' => 'CreateLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLabelingJobRequest', ], 'output' => [ 'shape' => 'CreateLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModel' => [ 'name' => 'CreateModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelInput', ], 'output' => [ 'shape' => 'CreateModelOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelBiasJobDefinition' => [ 'name' => 'CreateModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelCard' => [ 'name' => 'CreateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardRequest', ], 'output' => [ 'shape' => 'CreateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelCardExportJob' => [ 'name' => 'CreateModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardExportJobRequest', ], 'output' => [ 'shape' => 'CreateModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelExplainabilityJobDefinition' => [ 'name' => 'CreateModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelPackage' => [ 'name' => 'CreateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageInput', ], 'output' => [ 'shape' => 'CreateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelPackageGroup' => [ 'name' => 'CreateModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageGroupInput', ], 'output' => [ 'shape' => 'CreateModelPackageGroupOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelQualityJobDefinition' => [ 'name' => 'CreateModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateMonitoringSchedule' => [ 'name' => 'CreateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'CreateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateNotebookInstance' => [ 'name' => 'CreateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateNotebookInstanceLifecycleConfig' => [ 'name' => 'CreateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreatePipeline' => [ 'name' => 'CreatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePipelineRequest', ], 'output' => [ 'shape' => 'CreatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreatePresignedDomainUrl' => [ 'name' => 'CreatePresignedDomainUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedDomainUrlRequest', ], 'output' => [ 'shape' => 'CreatePresignedDomainUrlResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'CreatePresignedNotebookInstanceUrl' => [ 'name' => 'CreatePresignedNotebookInstanceUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlInput', ], 'output' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlOutput', ], ], 'CreateProcessingJob' => [ 'name' => 'CreateProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProcessingJobRequest', ], 'output' => [ 'shape' => 'CreateProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateProject' => [ 'name' => 'CreateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProjectInput', ], 'output' => [ 'shape' => 'CreateProjectOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateSpace' => [ 'name' => 'CreateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSpaceRequest', ], 'output' => [ 'shape' => 'CreateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateStudioLifecycleConfig' => [ 'name' => 'CreateStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'CreateStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateTrainingJob' => [ 'name' => 'CreateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrainingJobRequest', ], 'output' => [ 'shape' => 'CreateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTransformJob' => [ 'name' => 'CreateTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTransformJobRequest', ], 'output' => [ 'shape' => 'CreateTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTrial' => [ 'name' => 'CreateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialRequest', ], 'output' => [ 'shape' => 'CreateTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateTrialComponent' => [ 'name' => 'CreateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialComponentRequest', ], 'output' => [ 'shape' => 'CreateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateUserProfile' => [ 'name' => 'CreateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserProfileRequest', ], 'output' => [ 'shape' => 'CreateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateWorkforce' => [ 'name' => 'CreateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkforceRequest', ], 'output' => [ 'shape' => 'CreateWorkforceResponse', ], ], 'CreateWorkteam' => [ 'name' => 'CreateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkteamRequest', ], 'output' => [ 'shape' => 'CreateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeleteAction' => [ 'name' => 'DeleteAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteActionRequest', ], 'output' => [ 'shape' => 'DeleteActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAlgorithm' => [ 'name' => 'DeleteAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAlgorithmInput', ], ], 'DeleteApp' => [ 'name' => 'DeleteApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAppImageConfig' => [ 'name' => 'DeleteAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppImageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteArtifact' => [ 'name' => 'DeleteArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteArtifactRequest', ], 'output' => [ 'shape' => 'DeleteArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAssociation' => [ 'name' => 'DeleteAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAssociationRequest', ], 'output' => [ 'shape' => 'DeleteAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteCodeRepository' => [ 'name' => 'DeleteCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCodeRepositoryInput', ], ], 'DeleteContext' => [ 'name' => 'DeleteContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContextRequest', ], 'output' => [ 'shape' => 'DeleteContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDataQualityJobDefinition' => [ 'name' => 'DeleteDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDataQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDeviceFleet' => [ 'name' => 'DeleteDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteEdgeDeploymentPlan' => [ 'name' => 'DeleteEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentPlanRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEdgeDeploymentStage' => [ 'name' => 'DeleteEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEndpoint' => [ 'name' => 'DeleteEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointInput', ], ], 'DeleteEndpointConfig' => [ 'name' => 'DeleteEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointConfigInput', ], ], 'DeleteExperiment' => [ 'name' => 'DeleteExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteExperimentRequest', ], 'output' => [ 'shape' => 'DeleteExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFeatureGroup' => [ 'name' => 'DeleteFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFeatureGroupRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFlowDefinition' => [ 'name' => 'DeleteFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHub' => [ 'name' => 'DeleteHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHubContent' => [ 'name' => 'DeleteHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubContentRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHumanTaskUi' => [ 'name' => 'DeleteHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DeleteHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImage' => [ 'name' => 'DeleteImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageRequest', ], 'output' => [ 'shape' => 'DeleteImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImageVersion' => [ 'name' => 'DeleteImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageVersionRequest', ], 'output' => [ 'shape' => 'DeleteImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteInferenceExperiment' => [ 'name' => 'DeleteInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DeleteInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModel' => [ 'name' => 'DeleteModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelInput', ], ], 'DeleteModelBiasJobDefinition' => [ 'name' => 'DeleteModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelBiasJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelCard' => [ 'name' => 'DeleteModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelCardRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelExplainabilityJobDefinition' => [ 'name' => 'DeleteModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelExplainabilityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelPackage' => [ 'name' => 'DeleteModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroup' => [ 'name' => 'DeleteModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroupPolicy' => [ 'name' => 'DeleteModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupPolicyInput', ], ], 'DeleteModelQualityJobDefinition' => [ 'name' => 'DeleteModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteMonitoringSchedule' => [ 'name' => 'DeleteMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteNotebookInstance' => [ 'name' => 'DeleteNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceInput', ], ], 'DeleteNotebookInstanceLifecycleConfig' => [ 'name' => 'DeleteNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceLifecycleConfigInput', ], ], 'DeletePipeline' => [ 'name' => 'DeletePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePipelineRequest', ], 'output' => [ 'shape' => 'DeletePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteProject' => [ 'name' => 'DeleteProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProjectInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteSpace' => [ 'name' => 'DeleteSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSpaceRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteStudioLifecycleConfig' => [ 'name' => 'DeleteStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioLifecycleConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagsInput', ], 'output' => [ 'shape' => 'DeleteTagsOutput', ], ], 'DeleteTrial' => [ 'name' => 'DeleteTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialRequest', ], 'output' => [ 'shape' => 'DeleteTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteTrialComponent' => [ 'name' => 'DeleteTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialComponentRequest', ], 'output' => [ 'shape' => 'DeleteTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteUserProfile' => [ 'name' => 'DeleteUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserProfileRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteWorkforce' => [ 'name' => 'DeleteWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkforceRequest', ], 'output' => [ 'shape' => 'DeleteWorkforceResponse', ], ], 'DeleteWorkteam' => [ 'name' => 'DeleteWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkteamRequest', ], 'output' => [ 'shape' => 'DeleteWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeregisterDevices' => [ 'name' => 'DeregisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterDevicesRequest', ], ], 'DescribeAction' => [ 'name' => 'DescribeAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeActionRequest', ], 'output' => [ 'shape' => 'DescribeActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAlgorithm' => [ 'name' => 'DescribeAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAlgorithmInput', ], 'output' => [ 'shape' => 'DescribeAlgorithmOutput', ], ], 'DescribeApp' => [ 'name' => 'DescribeApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppRequest', ], 'output' => [ 'shape' => 'DescribeAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAppImageConfig' => [ 'name' => 'DescribeAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppImageConfigRequest', ], 'output' => [ 'shape' => 'DescribeAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeArtifact' => [ 'name' => 'DescribeArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeArtifactRequest', ], 'output' => [ 'shape' => 'DescribeArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJob' => [ 'name' => 'DescribeAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobRequest', ], 'output' => [ 'shape' => 'DescribeAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJobV2' => [ 'name' => 'DescribeAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobV2Request', ], 'output' => [ 'shape' => 'DescribeAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCodeRepository' => [ 'name' => 'DescribeCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCodeRepositoryInput', ], 'output' => [ 'shape' => 'DescribeCodeRepositoryOutput', ], ], 'DescribeCompilationJob' => [ 'name' => 'DescribeCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCompilationJobRequest', ], 'output' => [ 'shape' => 'DescribeCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeContext' => [ 'name' => 'DescribeContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContextRequest', ], 'output' => [ 'shape' => 'DescribeContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDataQualityJobDefinition' => [ 'name' => 'DescribeDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDevice' => [ 'name' => 'DescribeDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceRequest', ], 'output' => [ 'shape' => 'DescribeDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDeviceFleet' => [ 'name' => 'DescribeDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceFleetRequest', ], 'output' => [ 'shape' => 'DescribeDeviceFleetResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgeDeploymentPlan' => [ 'name' => 'DescribeEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'DescribeEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgePackagingJob' => [ 'name' => 'DescribeEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgePackagingJobRequest', ], 'output' => [ 'shape' => 'DescribeEdgePackagingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEndpoint' => [ 'name' => 'DescribeEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointInput', ], 'output' => [ 'shape' => 'DescribeEndpointOutput', ], ], 'DescribeEndpointConfig' => [ 'name' => 'DescribeEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointConfigInput', ], 'output' => [ 'shape' => 'DescribeEndpointConfigOutput', ], ], 'DescribeExperiment' => [ 'name' => 'DescribeExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExperimentRequest', ], 'output' => [ 'shape' => 'DescribeExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureGroup' => [ 'name' => 'DescribeFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureGroupRequest', ], 'output' => [ 'shape' => 'DescribeFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureMetadata' => [ 'name' => 'DescribeFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureMetadataRequest', ], 'output' => [ 'shape' => 'DescribeFeatureMetadataResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFlowDefinition' => [ 'name' => 'DescribeFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHub' => [ 'name' => 'DescribeHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubRequest', ], 'output' => [ 'shape' => 'DescribeHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHubContent' => [ 'name' => 'DescribeHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubContentRequest', ], 'output' => [ 'shape' => 'DescribeHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHumanTaskUi' => [ 'name' => 'DescribeHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DescribeHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHyperParameterTuningJob' => [ 'name' => 'DescribeHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'DescribeHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImage' => [ 'name' => 'DescribeImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageRequest', ], 'output' => [ 'shape' => 'DescribeImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImageVersion' => [ 'name' => 'DescribeImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageVersionRequest', ], 'output' => [ 'shape' => 'DescribeImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceExperiment' => [ 'name' => 'DescribeInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DescribeInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceRecommendationsJob' => [ 'name' => 'DescribeInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'DescribeInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLabelingJob' => [ 'name' => 'DescribeLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLabelingJobRequest', ], 'output' => [ 'shape' => 'DescribeLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLineageGroup' => [ 'name' => 'DescribeLineageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLineageGroupRequest', ], 'output' => [ 'shape' => 'DescribeLineageGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModel' => [ 'name' => 'DescribeModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelInput', ], 'output' => [ 'shape' => 'DescribeModelOutput', ], ], 'DescribeModelBiasJobDefinition' => [ 'name' => 'DescribeModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCard' => [ 'name' => 'DescribeModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardRequest', ], 'output' => [ 'shape' => 'DescribeModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCardExportJob' => [ 'name' => 'DescribeModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardExportJobRequest', ], 'output' => [ 'shape' => 'DescribeModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelExplainabilityJobDefinition' => [ 'name' => 'DescribeModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelPackage' => [ 'name' => 'DescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageInput', ], 'output' => [ 'shape' => 'DescribeModelPackageOutput', ], ], 'DescribeModelPackageGroup' => [ 'name' => 'DescribeModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageGroupInput', ], 'output' => [ 'shape' => 'DescribeModelPackageGroupOutput', ], ], 'DescribeModelQualityJobDefinition' => [ 'name' => 'DescribeModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeMonitoringSchedule' => [ 'name' => 'DescribeMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'DescribeMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeNotebookInstance' => [ 'name' => 'DescribeNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceOutput', ], ], 'DescribeNotebookInstanceLifecycleConfig' => [ 'name' => 'DescribeNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigOutput', ], ], 'DescribePipeline' => [ 'name' => 'DescribePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineRequest', ], 'output' => [ 'shape' => 'DescribePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineDefinitionForExecution' => [ 'name' => 'DescribePipelineDefinitionForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineDefinitionForExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineDefinitionForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineExecution' => [ 'name' => 'DescribePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProcessingJob' => [ 'name' => 'DescribeProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProcessingJobRequest', ], 'output' => [ 'shape' => 'DescribeProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProject' => [ 'name' => 'DescribeProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProjectInput', ], 'output' => [ 'shape' => 'DescribeProjectOutput', ], ], 'DescribeSpace' => [ 'name' => 'DescribeSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSpaceRequest', ], 'output' => [ 'shape' => 'DescribeSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeStudioLifecycleConfig' => [ 'name' => 'DescribeStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'DescribeStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeSubscribedWorkteam' => [ 'name' => 'DescribeSubscribedWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSubscribedWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeSubscribedWorkteamResponse', ], ], 'DescribeTrainingJob' => [ 'name' => 'DescribeTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrainingJobRequest', ], 'output' => [ 'shape' => 'DescribeTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTransformJob' => [ 'name' => 'DescribeTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTransformJobRequest', ], 'output' => [ 'shape' => 'DescribeTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrial' => [ 'name' => 'DescribeTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialRequest', ], 'output' => [ 'shape' => 'DescribeTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrialComponent' => [ 'name' => 'DescribeTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialComponentRequest', ], 'output' => [ 'shape' => 'DescribeTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeUserProfile' => [ 'name' => 'DescribeUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserProfileRequest', ], 'output' => [ 'shape' => 'DescribeUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeWorkforce' => [ 'name' => 'DescribeWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkforceRequest', ], 'output' => [ 'shape' => 'DescribeWorkforceResponse', ], ], 'DescribeWorkteam' => [ 'name' => 'DescribeWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeWorkteamResponse', ], ], 'DisableSagemakerServicecatalogPortfolio' => [ 'name' => 'DisableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioOutput', ], ], 'DisassociateTrialComponent' => [ 'name' => 'DisassociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateTrialComponentRequest', ], 'output' => [ 'shape' => 'DisassociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'EnableSagemakerServicecatalogPortfolio' => [ 'name' => 'EnableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioOutput', ], ], 'GetDeviceFleetReport' => [ 'name' => 'GetDeviceFleetReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceFleetReportRequest', ], 'output' => [ 'shape' => 'GetDeviceFleetReportResponse', ], ], 'GetLineageGroupPolicy' => [ 'name' => 'GetLineageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLineageGroupPolicyRequest', ], 'output' => [ 'shape' => 'GetLineageGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetModelPackageGroupPolicy' => [ 'name' => 'GetModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'GetModelPackageGroupPolicyOutput', ], ], 'GetSagemakerServicecatalogPortfolioStatus' => [ 'name' => 'GetSagemakerServicecatalogPortfolioStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusInput', ], 'output' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusOutput', ], ], 'GetSearchSuggestions' => [ 'name' => 'GetSearchSuggestions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSearchSuggestionsRequest', ], 'output' => [ 'shape' => 'GetSearchSuggestionsResponse', ], ], 'ImportHubContent' => [ 'name' => 'ImportHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportHubContentRequest', ], 'output' => [ 'shape' => 'ImportHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'ListActions' => [ 'name' => 'ListActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListActionsRequest', ], 'output' => [ 'shape' => 'ListActionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAlgorithms' => [ 'name' => 'ListAlgorithms', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAlgorithmsInput', ], 'output' => [ 'shape' => 'ListAlgorithmsOutput', ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesRequest', ], 'output' => [ 'shape' => 'ListAliasesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAppImageConfigs' => [ 'name' => 'ListAppImageConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppImageConfigsRequest', ], 'output' => [ 'shape' => 'ListAppImageConfigsResponse', ], ], 'ListApps' => [ 'name' => 'ListApps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppsRequest', ], 'output' => [ 'shape' => 'ListAppsResponse', ], ], 'ListArtifacts' => [ 'name' => 'ListArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListArtifactsRequest', ], 'output' => [ 'shape' => 'ListArtifactsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAssociations' => [ 'name' => 'ListAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAssociationsRequest', ], 'output' => [ 'shape' => 'ListAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAutoMLJobs' => [ 'name' => 'ListAutoMLJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAutoMLJobsRequest', ], 'output' => [ 'shape' => 'ListAutoMLJobsResponse', ], ], 'ListCandidatesForAutoMLJob' => [ 'name' => 'ListCandidatesForAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCandidatesForAutoMLJobRequest', ], 'output' => [ 'shape' => 'ListCandidatesForAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListCodeRepositories' => [ 'name' => 'ListCodeRepositories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCodeRepositoriesInput', ], 'output' => [ 'shape' => 'ListCodeRepositoriesOutput', ], ], 'ListCompilationJobs' => [ 'name' => 'ListCompilationJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCompilationJobsRequest', ], 'output' => [ 'shape' => 'ListCompilationJobsResponse', ], ], 'ListContexts' => [ 'name' => 'ListContexts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContextsRequest', ], 'output' => [ 'shape' => 'ListContextsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListDataQualityJobDefinitions' => [ 'name' => 'ListDataQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDataQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListDataQualityJobDefinitionsResponse', ], ], 'ListDeviceFleets' => [ 'name' => 'ListDeviceFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDeviceFleetsRequest', ], 'output' => [ 'shape' => 'ListDeviceFleetsResponse', ], ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResponse', ], ], 'ListDomains' => [ 'name' => 'ListDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDomainsRequest', ], 'output' => [ 'shape' => 'ListDomainsResponse', ], ], 'ListEdgeDeploymentPlans' => [ 'name' => 'ListEdgeDeploymentPlans', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgeDeploymentPlansRequest', ], 'output' => [ 'shape' => 'ListEdgeDeploymentPlansResponse', ], ], 'ListEdgePackagingJobs' => [ 'name' => 'ListEdgePackagingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgePackagingJobsRequest', ], 'output' => [ 'shape' => 'ListEdgePackagingJobsResponse', ], ], 'ListEndpointConfigs' => [ 'name' => 'ListEndpointConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointConfigsInput', ], 'output' => [ 'shape' => 'ListEndpointConfigsOutput', ], ], 'ListEndpoints' => [ 'name' => 'ListEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointsInput', ], 'output' => [ 'shape' => 'ListEndpointsOutput', ], ], 'ListExperiments' => [ 'name' => 'ListExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListExperimentsRequest', ], 'output' => [ 'shape' => 'ListExperimentsResponse', ], ], 'ListFeatureGroups' => [ 'name' => 'ListFeatureGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFeatureGroupsRequest', ], 'output' => [ 'shape' => 'ListFeatureGroupsResponse', ], ], 'ListFlowDefinitions' => [ 'name' => 'ListFlowDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFlowDefinitionsRequest', ], 'output' => [ 'shape' => 'ListFlowDefinitionsResponse', ], ], 'ListHubContentVersions' => [ 'name' => 'ListHubContentVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentVersionsRequest', ], 'output' => [ 'shape' => 'ListHubContentVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubContents' => [ 'name' => 'ListHubContents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentsRequest', ], 'output' => [ 'shape' => 'ListHubContentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubs' => [ 'name' => 'ListHubs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubsRequest', ], 'output' => [ 'shape' => 'ListHubsResponse', ], ], 'ListHumanTaskUis' => [ 'name' => 'ListHumanTaskUis', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHumanTaskUisRequest', ], 'output' => [ 'shape' => 'ListHumanTaskUisResponse', ], ], 'ListHyperParameterTuningJobs' => [ 'name' => 'ListHyperParameterTuningJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHyperParameterTuningJobsRequest', ], 'output' => [ 'shape' => 'ListHyperParameterTuningJobsResponse', ], ], 'ListImageVersions' => [ 'name' => 'ListImageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImageVersionsRequest', ], 'output' => [ 'shape' => 'ListImageVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListImages' => [ 'name' => 'ListImages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImagesRequest', ], 'output' => [ 'shape' => 'ListImagesResponse', ], ], 'ListInferenceExperiments' => [ 'name' => 'ListInferenceExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceExperimentsRequest', ], 'output' => [ 'shape' => 'ListInferenceExperimentsResponse', ], ], 'ListInferenceRecommendationsJobSteps' => [ 'name' => 'ListInferenceRecommendationsJobSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobStepsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListInferenceRecommendationsJobs' => [ 'name' => 'ListInferenceRecommendationsJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobsResponse', ], ], 'ListLabelingJobs' => [ 'name' => 'ListLabelingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsResponse', ], ], 'ListLabelingJobsForWorkteam' => [ 'name' => 'ListLabelingJobsForWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsForWorkteamRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsForWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListLineageGroups' => [ 'name' => 'ListLineageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLineageGroupsRequest', ], 'output' => [ 'shape' => 'ListLineageGroupsResponse', ], ], 'ListModelBiasJobDefinitions' => [ 'name' => 'ListModelBiasJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelBiasJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelBiasJobDefinitionsResponse', ], ], 'ListModelCardExportJobs' => [ 'name' => 'ListModelCardExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardExportJobsRequest', ], 'output' => [ 'shape' => 'ListModelCardExportJobsResponse', ], ], 'ListModelCardVersions' => [ 'name' => 'ListModelCardVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardVersionsRequest', ], 'output' => [ 'shape' => 'ListModelCardVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListModelCards' => [ 'name' => 'ListModelCards', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardsRequest', ], 'output' => [ 'shape' => 'ListModelCardsResponse', ], ], 'ListModelExplainabilityJobDefinitions' => [ 'name' => 'ListModelExplainabilityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsResponse', ], ], 'ListModelMetadata' => [ 'name' => 'ListModelMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelMetadataRequest', ], 'output' => [ 'shape' => 'ListModelMetadataResponse', ], ], 'ListModelPackageGroups' => [ 'name' => 'ListModelPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackageGroupsInput', ], 'output' => [ 'shape' => 'ListModelPackageGroupsOutput', ], ], 'ListModelPackages' => [ 'name' => 'ListModelPackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackagesInput', ], 'output' => [ 'shape' => 'ListModelPackagesOutput', ], ], 'ListModelQualityJobDefinitions' => [ 'name' => 'ListModelQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelQualityJobDefinitionsResponse', ], ], 'ListModels' => [ 'name' => 'ListModels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelsInput', ], 'output' => [ 'shape' => 'ListModelsOutput', ], ], 'ListMonitoringAlertHistory' => [ 'name' => 'ListMonitoringAlertHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertHistoryRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertHistoryResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringAlerts' => [ 'name' => 'ListMonitoringAlerts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertsRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringExecutions' => [ 'name' => 'ListMonitoringExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringExecutionsRequest', ], 'output' => [ 'shape' => 'ListMonitoringExecutionsResponse', ], ], 'ListMonitoringSchedules' => [ 'name' => 'ListMonitoringSchedules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringSchedulesRequest', ], 'output' => [ 'shape' => 'ListMonitoringSchedulesResponse', ], ], 'ListNotebookInstanceLifecycleConfigs' => [ 'name' => 'ListNotebookInstanceLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsInput', ], 'output' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsOutput', ], ], 'ListNotebookInstances' => [ 'name' => 'ListNotebookInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstancesInput', ], 'output' => [ 'shape' => 'ListNotebookInstancesOutput', ], ], 'ListPipelineExecutionSteps' => [ 'name' => 'ListPipelineExecutionSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionStepsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineExecutions' => [ 'name' => 'ListPipelineExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineParametersForExecution' => [ 'name' => 'ListPipelineParametersForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineParametersForExecutionRequest', ], 'output' => [ 'shape' => 'ListPipelineParametersForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelines' => [ 'name' => 'ListPipelines', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelinesRequest', ], 'output' => [ 'shape' => 'ListPipelinesResponse', ], ], 'ListProcessingJobs' => [ 'name' => 'ListProcessingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProcessingJobsRequest', ], 'output' => [ 'shape' => 'ListProcessingJobsResponse', ], ], 'ListProjects' => [ 'name' => 'ListProjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProjectsInput', ], 'output' => [ 'shape' => 'ListProjectsOutput', ], ], 'ListResourceCatalogs' => [ 'name' => 'ListResourceCatalogs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceCatalogsRequest', ], 'output' => [ 'shape' => 'ListResourceCatalogsResponse', ], ], 'ListSpaces' => [ 'name' => 'ListSpaces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSpacesRequest', ], 'output' => [ 'shape' => 'ListSpacesResponse', ], ], 'ListStageDevices' => [ 'name' => 'ListStageDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStageDevicesRequest', ], 'output' => [ 'shape' => 'ListStageDevicesResponse', ], ], 'ListStudioLifecycleConfigs' => [ 'name' => 'ListStudioLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudioLifecycleConfigsRequest', ], 'output' => [ 'shape' => 'ListStudioLifecycleConfigsResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'ListSubscribedWorkteams' => [ 'name' => 'ListSubscribedWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSubscribedWorkteamsRequest', ], 'output' => [ 'shape' => 'ListSubscribedWorkteamsResponse', ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsInput', ], 'output' => [ 'shape' => 'ListTagsOutput', ], ], 'ListTrainingJobs' => [ 'name' => 'ListTrainingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsResponse', ], ], 'ListTrainingJobsForHyperParameterTuningJob' => [ 'name' => 'ListTrainingJobsForHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTransformJobs' => [ 'name' => 'ListTransformJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTransformJobsRequest', ], 'output' => [ 'shape' => 'ListTransformJobsResponse', ], ], 'ListTrialComponents' => [ 'name' => 'ListTrialComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialComponentsRequest', ], 'output' => [ 'shape' => 'ListTrialComponentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTrials' => [ 'name' => 'ListTrials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialsRequest', ], 'output' => [ 'shape' => 'ListTrialsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListUserProfiles' => [ 'name' => 'ListUserProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserProfilesRequest', ], 'output' => [ 'shape' => 'ListUserProfilesResponse', ], ], 'ListWorkforces' => [ 'name' => 'ListWorkforces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkforcesRequest', ], 'output' => [ 'shape' => 'ListWorkforcesResponse', ], ], 'ListWorkteams' => [ 'name' => 'ListWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkteamsRequest', ], 'output' => [ 'shape' => 'ListWorkteamsResponse', ], ], 'PutModelPackageGroupPolicy' => [ 'name' => 'PutModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'PutModelPackageGroupPolicyOutput', ], ], 'QueryLineage' => [ 'name' => 'QueryLineage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'QueryLineageRequest', ], 'output' => [ 'shape' => 'QueryLineageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RegisterDevices' => [ 'name' => 'RegisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterDevicesRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'RenderUiTemplate' => [ 'name' => 'RenderUiTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RenderUiTemplateRequest', ], 'output' => [ 'shape' => 'RenderUiTemplateResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RetryPipelineExecution' => [ 'name' => 'RetryPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RetryPipelineExecutionRequest', ], 'output' => [ 'shape' => 'RetryPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'Search' => [ 'name' => 'Search', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchRequest', ], 'output' => [ 'shape' => 'SearchResponse', ], ], 'SendPipelineExecutionStepFailure' => [ 'name' => 'SendPipelineExecutionStepFailure', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepFailureRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepFailureResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'SendPipelineExecutionStepSuccess' => [ 'name' => 'SendPipelineExecutionStepSuccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepSuccessRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepSuccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StartEdgeDeploymentStage' => [ 'name' => 'StartEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartEdgeDeploymentStageRequest', ], ], 'StartInferenceExperiment' => [ 'name' => 'StartInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StartInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StartMonitoringSchedule' => [ 'name' => 'StartMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StartNotebookInstance' => [ 'name' => 'StartNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartNotebookInstanceInput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StartPipelineExecution' => [ 'name' => 'StartPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StartPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StopAutoMLJob' => [ 'name' => 'StopAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopAutoMLJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopCompilationJob' => [ 'name' => 'StopCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopEdgeDeploymentStage' => [ 'name' => 'StopEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgeDeploymentStageRequest', ], ], 'StopEdgePackagingJob' => [ 'name' => 'StopEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgePackagingJobRequest', ], ], 'StopHyperParameterTuningJob' => [ 'name' => 'StopHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopHyperParameterTuningJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceExperiment' => [ 'name' => 'StopInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StopInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceRecommendationsJob' => [ 'name' => 'StopInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceRecommendationsJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopLabelingJob' => [ 'name' => 'StopLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopLabelingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopMonitoringSchedule' => [ 'name' => 'StopMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopNotebookInstance' => [ 'name' => 'StopNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopNotebookInstanceInput', ], ], 'StopPipelineExecution' => [ 'name' => 'StopPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StopPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopProcessingJob' => [ 'name' => 'StopProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopProcessingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTrainingJob' => [ 'name' => 'StopTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTrainingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTransformJob' => [ 'name' => 'StopTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTransformJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAction' => [ 'name' => 'UpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateActionRequest', ], 'output' => [ 'shape' => 'UpdateActionResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAppImageConfig' => [ 'name' => 'UpdateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAppImageConfigRequest', ], 'output' => [ 'shape' => 'UpdateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateArtifact' => [ 'name' => 'UpdateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateArtifactRequest', ], 'output' => [ 'shape' => 'UpdateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateCodeRepository' => [ 'name' => 'UpdateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCodeRepositoryInput', ], 'output' => [ 'shape' => 'UpdateCodeRepositoryOutput', ], ], 'UpdateContext' => [ 'name' => 'UpdateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContextRequest', ], 'output' => [ 'shape' => 'UpdateContextResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateDeviceFleet' => [ 'name' => 'UpdateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'UpdateDevices' => [ 'name' => 'UpdateDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDevicesRequest', ], ], 'UpdateDomain' => [ 'name' => 'UpdateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainRequest', ], 'output' => [ 'shape' => 'UpdateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateEndpoint' => [ 'name' => 'UpdateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointInput', ], 'output' => [ 'shape' => 'UpdateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateEndpointWeightsAndCapacities' => [ 'name' => 'UpdateEndpointWeightsAndCapacities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesInput', ], 'output' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateExperiment' => [ 'name' => 'UpdateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateExperimentRequest', ], 'output' => [ 'shape' => 'UpdateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateFeatureGroup' => [ 'name' => 'UpdateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureGroupRequest', ], 'output' => [ 'shape' => 'UpdateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateFeatureMetadata' => [ 'name' => 'UpdateFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureMetadataRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateHub' => [ 'name' => 'UpdateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateHubRequest', ], 'output' => [ 'shape' => 'UpdateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImage' => [ 'name' => 'UpdateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageRequest', ], 'output' => [ 'shape' => 'UpdateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImageVersion' => [ 'name' => 'UpdateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageVersionRequest', ], 'output' => [ 'shape' => 'UpdateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateInferenceExperiment' => [ 'name' => 'UpdateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'UpdateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateModelCard' => [ 'name' => 'UpdateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelCardRequest', ], 'output' => [ 'shape' => 'UpdateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateModelPackage' => [ 'name' => 'UpdateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelPackageInput', ], 'output' => [ 'shape' => 'UpdateModelPackageOutput', ], ], 'UpdateMonitoringAlert' => [ 'name' => 'UpdateMonitoringAlert', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringAlertRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringAlertResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateMonitoringSchedule' => [ 'name' => 'UpdateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateNotebookInstance' => [ 'name' => 'UpdateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateNotebookInstanceLifecycleConfig' => [ 'name' => 'UpdateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdatePipeline' => [ 'name' => 'UpdatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineRequest', ], 'output' => [ 'shape' => 'UpdatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdatePipelineExecution' => [ 'name' => 'UpdatePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineExecutionRequest', ], 'output' => [ 'shape' => 'UpdatePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateProject' => [ 'name' => 'UpdateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProjectInput', ], 'output' => [ 'shape' => 'UpdateProjectOutput', ], ], 'UpdateSpace' => [ 'name' => 'UpdateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateSpaceRequest', ], 'output' => [ 'shape' => 'UpdateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrainingJob' => [ 'name' => 'UpdateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrainingJobRequest', ], 'output' => [ 'shape' => 'UpdateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrial' => [ 'name' => 'UpdateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialRequest', ], 'output' => [ 'shape' => 'UpdateTrialResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrialComponent' => [ 'name' => 'UpdateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialComponentRequest', ], 'output' => [ 'shape' => 'UpdateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateUserProfile' => [ 'name' => 'UpdateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserProfileRequest', ], 'output' => [ 'shape' => 'UpdateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateWorkforce' => [ 'name' => 'UpdateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkforceRequest', ], 'output' => [ 'shape' => 'UpdateWorkforceResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateWorkteam' => [ 'name' => 'UpdateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkteamRequest', ], 'output' => [ 'shape' => 'UpdateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], ], 'shapes' => [ 'Accept' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'AccountId' => [ 'type' => 'string', 'pattern' => '^\\d+$', ], 'ActionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*', ], 'ActionSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'String2048', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'Unknown', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionSummary', ], ], 'ActionSummary' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String64', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AddAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'AddAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'AddTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AddTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'max' => 3, ], 'AdditionalInferenceSpecificationDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Containers', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'AdditionalInferenceSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalInferenceSpecificationDefinition', ], 'max' => 15, 'min' => 1, ], 'AgentVersion' => [ 'type' => 'structure', 'required' => [ 'Version', 'AgentCount', ], 'members' => [ 'Version' => [ 'shape' => 'EdgeVersion', ], 'AgentCount' => [ 'shape' => 'Long', ], ], ], 'AgentVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentVersion', ], ], 'AggregationTransformationValue' => [ 'type' => 'string', 'enum' => [ 'sum', 'avg', 'first', 'min', 'max', ], ], 'AggregationTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'AggregationTransformationValue', ], 'max' => 50, 'min' => 1, ], 'Alarm' => [ 'type' => 'structure', 'members' => [ 'AlarmName' => [ 'shape' => 'AlarmName', ], ], ], 'AlarmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alarm', ], 'max' => 10, 'min' => 1, ], 'AlarmName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(?!\\s*$).+', ], 'AlgorithmArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:algorithm/.*', ], 'AlgorithmImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'AlgorithmSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'AlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'EnableSageMakerMetricsTimeSeries' => [ 'shape' => 'Boolean', ], 'ContainerEntrypoint' => [ 'shape' => 'TrainingContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'TrainingContainerArguments', ], 'TrainingImageConfig' => [ 'shape' => 'TrainingImageConfig', ], ], ], 'AlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'AlgorithmStatusDetails' => [ 'type' => 'structure', 'members' => [ 'ValidationStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], ], ], 'AlgorithmStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedAlgorithmStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'AlgorithmStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmStatusItem', ], ], 'AlgorithmSummary' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'AlgorithmStatus', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], ], ], 'AlgorithmSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmSummary', ], ], 'AlgorithmValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TrainingJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TrainingJobDefinition' => [ 'shape' => 'TrainingJobDefinition', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'AlgorithmValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmValidationProfile', ], 'max' => 1, 'min' => 1, ], 'AlgorithmValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'AlgorithmValidationProfiles', ], ], ], 'AnnotationConsolidationConfig' => [ 'type' => 'structure', 'required' => [ 'AnnotationConsolidationLambdaArn', ], 'members' => [ 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], ], ], 'AppArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*', ], 'AppDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'AppImageConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*', ], 'AppImageConfigDetails' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], ], ], 'AppImageConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppImageConfigDetails', ], ], 'AppImageConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppImageConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'AppInstanceType' => [ 'type' => 'string', 'enum' => [ 'system', 'ml.t3.micro', 'ml.t3.small', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.geospatial.interactive', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', ], ], 'AppList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppDetails', ], ], 'AppManaged' => [ 'type' => 'boolean', ], 'AppName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppNetworkAccessType' => [ 'type' => 'string', 'enum' => [ 'PublicInternetOnly', 'VpcOnly', ], ], 'AppSecurityGroupManagement' => [ 'type' => 'string', 'enum' => [ 'Service', 'Customer', ], ], 'AppSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'AppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'ContainerArguments', ], ], ], 'AppStatus' => [ 'type' => 'string', 'enum' => [ 'Deleted', 'Deleting', 'Failed', 'InService', 'Pending', ], ], 'AppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'TensorBoard', 'RStudioServerPro', 'RSessionGateway', ], ], 'ApprovalDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'ArnOrName' => [ 'type' => 'string', 'max' => 170, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:artifact/.*', ], 'ArtifactDigest' => [ 'type' => 'string', 'pattern' => '^[\\w:]+$', ], 'ArtifactSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'String2048', ], 'SourceTypes' => [ 'shape' => 'ArtifactSourceTypes', ], ], ], 'ArtifactSourceIdType' => [ 'type' => 'string', 'enum' => [ 'MD5Hash', 'S3ETag', 'S3Version', 'Custom', ], ], 'ArtifactSourceType' => [ 'type' => 'structure', 'required' => [ 'SourceIdType', 'Value', ], 'members' => [ 'SourceIdType' => [ 'shape' => 'ArtifactSourceIdType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ArtifactSourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSourceType', ], ], 'ArtifactSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSummary', ], ], 'ArtifactSummary' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AssemblyType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', ], ], 'AssociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'AssociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'AssociationEdgeType' => [ 'type' => 'string', 'enum' => [ 'ContributedTo', 'AssociatedWith', 'DerivedFrom', 'Produced', ], ], 'AssociationEntityArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*', ], 'AssociationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationSummary', ], ], 'AssociationSummary' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'SourceName' => [ 'shape' => 'ExperimentEntityName', ], 'DestinationName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'AsyncInferenceClientConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrentInvocationsPerInstance' => [ 'shape' => 'MaxConcurrentInvocationsPerInstance', ], ], ], 'AsyncInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'OutputConfig', ], 'members' => [ 'ClientConfig' => [ 'shape' => 'AsyncInferenceClientConfig', ], 'OutputConfig' => [ 'shape' => 'AsyncInferenceOutputConfig', ], ], ], 'AsyncInferenceNotificationConfig' => [ 'type' => 'structure', 'members' => [ 'SuccessTopic' => [ 'shape' => 'SnsTopicArn', ], 'ErrorTopic' => [ 'shape' => 'SnsTopicArn', ], 'IncludeInferenceResponseIn' => [ 'shape' => 'AsyncNotificationTopicTypeList', ], ], ], 'AsyncInferenceOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'DestinationS3Uri', ], 'NotificationConfig' => [ 'shape' => 'AsyncInferenceNotificationConfig', ], 'S3FailurePath' => [ 'shape' => 'DestinationS3Uri', ], ], ], 'AsyncNotificationTopicTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AsyncNotificationTopicTypes', ], 'max' => 2, 'min' => 0, ], 'AsyncNotificationTopicTypes' => [ 'type' => 'string', 'enum' => [ 'SUCCESS_NOTIFICATION_TOPIC', 'ERROR_NOTIFICATION_TOPIC', ], ], 'AthenaCatalog' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'AthenaDatabase' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'AthenaDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'Catalog', 'Database', 'QueryString', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'Catalog' => [ 'shape' => 'AthenaCatalog', ], 'Database' => [ 'shape' => 'AthenaDatabase', ], 'QueryString' => [ 'shape' => 'AthenaQueryString', ], 'WorkGroup' => [ 'shape' => 'AthenaWorkGroup', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'AthenaResultFormat', ], 'OutputCompression' => [ 'shape' => 'AthenaResultCompressionType', ], ], ], 'AthenaQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'AthenaResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'SNAPPY', 'ZLIB', ], ], 'AthenaResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'ORC', 'AVRO', 'JSON', 'TEXTFILE', ], ], 'AthenaWorkGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9._-]+', ], 'AttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.+', ], 'AttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeName', ], 'max' => 16, ], 'AuthMode' => [ 'type' => 'string', 'enum' => [ 'SSO', 'IAM', ], ], 'AutoGenerateEndpointName' => [ 'type' => 'boolean', ], 'AutoMLAlgorithm' => [ 'type' => 'string', 'enum' => [ 'xgboost', 'linear-learner', 'mlp', 'lightgbm', 'catboost', 'randomforest', 'extra-trees', 'nn-torch', 'fastai', ], ], 'AutoMLAlgorithmConfig' => [ 'type' => 'structure', 'required' => [ 'AutoMLAlgorithms', ], 'members' => [ 'AutoMLAlgorithms' => [ 'shape' => 'AutoMLAlgorithms', ], ], ], 'AutoMLAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithm', ], 'max' => 11, ], 'AutoMLAlgorithmsConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithmConfig', ], 'max' => 1, ], 'AutoMLCandidate' => [ 'type' => 'structure', 'required' => [ 'CandidateName', 'ObjectiveStatus', 'CandidateSteps', 'CandidateStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CandidateName' => [ 'shape' => 'CandidateName', ], 'FinalAutoMLJobObjectiveMetric' => [ 'shape' => 'FinalAutoMLJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], 'CandidateSteps' => [ 'shape' => 'CandidateSteps', ], 'CandidateStatus' => [ 'shape' => 'CandidateStatus', ], 'InferenceContainers' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'CandidateProperties' => [ 'shape' => 'CandidateProperties', ], 'InferenceContainerDefinitions' => [ 'shape' => 'AutoMLInferenceContainerDefinitions', ], ], ], 'AutoMLCandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'AutoMLCandidateStep' => [ 'type' => 'structure', 'required' => [ 'CandidateStepType', 'CandidateStepArn', 'CandidateStepName', ], 'members' => [ 'CandidateStepType' => [ 'shape' => 'CandidateStepType', ], 'CandidateStepArn' => [ 'shape' => 'CandidateStepArn', ], 'CandidateStepName' => [ 'shape' => 'CandidateStepName', ], ], ], 'AutoMLCandidates' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidate', ], ], 'AutoMLChannel' => [ 'type' => 'structure', 'required' => [ 'DataSource', 'TargetAttributeName', ], 'members' => [ 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'AutoMLChannelType' => [ 'type' => 'string', 'enum' => [ 'training', 'validation', ], ], 'AutoMLContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', 'ModelDataUrl', ], 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'AutoMLContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLContainerDefinition', ], 'max' => 5, ], 'AutoMLDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'AutoMLS3DataSource', ], ], ], 'AutoMLDataSplitConfig' => [ 'type' => 'structure', 'members' => [ 'ValidationFraction' => [ 'shape' => 'ValidationFraction', ], ], ], 'AutoMLFailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'AutoMLInferenceContainerDefinitions' => [ 'type' => 'map', 'key' => [ 'shape' => 'AutoMLProcessingUnit', ], 'value' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'max' => 2, ], 'AutoMLInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:automl-job/.*', ], 'AutoMLJobArtifacts' => [ 'type' => 'structure', 'members' => [ 'CandidateDefinitionNotebookLocation' => [ 'shape' => 'CandidateDefinitionNotebookLocation', ], 'DataExplorationNotebookLocation' => [ 'shape' => 'DataExplorationNotebookLocation', ], ], ], 'AutoMLJobChannel' => [ 'type' => 'structure', 'members' => [ 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], ], ], 'AutoMLJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'MaxCandidates' => [ 'shape' => 'MaxCandidates', ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'shape' => 'MaxRuntimePerTrainingJobInSeconds', ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'shape' => 'MaxAutoMLJobRuntimeInSeconds', ], ], ], 'AutoMLJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'CandidateGenerationConfig' => [ 'shape' => 'AutoMLCandidateGenerationConfig', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], ], ], 'AutoMLJobInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'AutoMLJobObjective' => [ 'type' => 'structure', 'required' => [ 'MetricName', ], 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'AutoMLJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'AutoMLJobSecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'AnalyzingData', 'FeatureEngineering', 'ModelTuning', 'MaxCandidatesReached', 'Failed', 'Stopped', 'MaxAutoMLJobRuntimeReached', 'Stopping', 'CandidateDefinitionsGenerated', 'GeneratingExplainabilityReport', 'Completed', 'ExplainabilityError', 'DeployingModel', 'ModelDeploymentError', 'GeneratingModelInsightsReport', 'ModelInsightsError', 'TrainingModels', 'PreTraining', ], ], 'AutoMLJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'AutoMLJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'AutoMLJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobSummary', ], ], 'AutoMLJobSummary' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], ], ], 'AutoMLMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'AutoMLMetricEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'MAE', 'R2', 'BalancedAccuracy', 'Precision', 'PrecisionMacro', 'Recall', 'RecallMacro', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', ], ], 'AutoMLMetricExtendedEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'MAE', 'R2', 'BalancedAccuracy', 'Precision', 'PrecisionMacro', 'Recall', 'RecallMacro', 'LogLoss', 'InferenceLatency', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', ], ], 'AutoMLMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'ENSEMBLING', 'HYPERPARAMETER_TUNING', ], ], 'AutoMLNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'AutoMLOutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLPartialFailureReason' => [ 'type' => 'structure', 'members' => [ 'PartialFailureMessage' => [ 'shape' => 'AutoMLFailureReason', ], ], ], 'AutoMLPartialFailureReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLPartialFailureReason', ], 'max' => 5, 'min' => 1, ], 'AutoMLProblemTypeConfig' => [ 'type' => 'structure', 'members' => [ 'ImageClassificationJobConfig' => [ 'shape' => 'ImageClassificationJobConfig', ], 'TextClassificationJobConfig' => [ 'shape' => 'TextClassificationJobConfig', ], 'TabularJobConfig' => [ 'shape' => 'TabularJobConfig', ], 'TimeSeriesForecastingJobConfig' => [ 'shape' => 'TimeSeriesForecastingJobConfig', ], ], 'union' => true, ], 'AutoMLProblemTypeConfigName' => [ 'type' => 'string', 'enum' => [ 'ImageClassification', 'TextClassification', 'Tabular', 'TimeSeriesForecasting', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'TabularResolvedAttributes' => [ 'shape' => 'TabularResolvedAttributes', ], ], 'union' => true, ], 'AutoMLProcessingUnit' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'AutoMLResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'AutoMLProblemTypeResolvedAttributes' => [ 'shape' => 'AutoMLProblemTypeResolvedAttributes', ], ], ], 'AutoMLS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AutoMLS3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'AutoMLSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'AutoMLSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'AutoMLSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'AutoParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'ValueHint', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'ValueHint' => [ 'shape' => 'ParameterValue', ], ], ], 'AutoParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoParameter', ], 'max' => 100, 'min' => 0, ], 'AutoRollbackConfig' => [ 'type' => 'structure', 'members' => [ 'Alarms' => [ 'shape' => 'AlarmList', ], ], ], 'Autotune' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'AutotuneMode', ], ], ], 'AutotuneMode' => [ 'type' => 'string', 'enum' => [ 'Enabled', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'type' => 'string', 'enum' => [ 'AWS/Rekognition/DetectModerationLabels/Image/V3', 'AWS/Textract/AnalyzeDocument/Forms/V1', ], ], 'BacktestResultsLocation' => [ 'type' => 'string', 'min' => 1, ], 'BatchDataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'GenerateInferenceId' => [ 'shape' => 'Boolean', ], ], ], 'BatchDescribeModelPackageError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', 'ErrorResponse', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorResponse' => [ 'shape' => 'String', ], ], ], 'BatchDescribeModelPackageErrorMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageError', ], ], 'BatchDescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArnList', ], 'members' => [ 'ModelPackageArnList' => [ 'shape' => 'ModelPackageArnList', ], ], ], 'BatchDescribeModelPackageOutput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageSummaries' => [ 'shape' => 'ModelPackageSummaries', ], 'BatchDescribeModelPackageErrorMap' => [ 'shape' => 'BatchDescribeModelPackageErrorMap', ], ], ], 'BatchDescribeModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageArn', 'CreationTime', 'InferenceSpecification', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'BatchStrategy' => [ 'type' => 'string', 'enum' => [ 'MultiRecord', 'SingleRecord', ], ], 'BatchTransformInput' => [ 'type' => 'structure', 'required' => [ 'DataCapturedDestinationS3Uri', 'DatasetFormat', 'LocalPath', ], 'members' => [ 'DataCapturedDestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'DatasetFormat' => [ 'shape' => 'MonitoringDatasetFormat', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], ], ], 'BestObjectiveNotImproving' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTrainingJobsNotImproving' => [ 'shape' => 'MaxNumberOfTrainingJobsNotImproving', ], ], ], 'Bias' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], 'PreTrainingReport' => [ 'shape' => 'MetricsSource', ], 'PostTrainingReport' => [ 'shape' => 'MetricsSource', ], ], ], 'BillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'BlockedReason' => [ 'type' => 'string', 'max' => 1024, ], 'BlueGreenUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'TrafficRoutingConfiguration', ], 'members' => [ 'TrafficRoutingConfiguration' => [ 'shape' => 'TrafficRoutingConfig', ], 'TerminationWaitInSeconds' => [ 'shape' => 'TerminationWaitInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOperator' => [ 'type' => 'string', 'enum' => [ 'And', 'Or', ], ], 'Branch' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[^ ~^:?*\\[]+', ], 'BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]', ], 'CacheHitResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'CallbackStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'SqsQueueUrl' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'CallbackToken' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^[a-zA-Z0-9]+$', ], 'CandidateArtifactLocations' => [ 'type' => 'structure', 'required' => [ 'Explainability', ], 'members' => [ 'Explainability' => [ 'shape' => 'ExplainabilityLocation', ], 'ModelInsights' => [ 'shape' => 'ModelInsightsLocation', ], 'BacktestResults' => [ 'shape' => 'BacktestResultsLocation', ], ], ], 'CandidateDefinitionNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'CandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'CandidateName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateProperties' => [ 'type' => 'structure', 'members' => [ 'CandidateArtifactLocations' => [ 'shape' => 'CandidateArtifactLocations', ], 'CandidateMetrics' => [ 'shape' => 'MetricDataList', ], ], ], 'CandidateSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'CandidateStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'CandidateStepArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/.*', ], 'CandidateStepName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateStepType' => [ 'type' => 'string', 'enum' => [ 'AWS::SageMaker::TrainingJob', 'AWS::SageMaker::TransformJob', 'AWS::SageMaker::ProcessingJob', ], ], 'CandidateSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidateStep', ], ], 'CanvasAppSettings' => [ 'type' => 'structure', 'members' => [ 'TimeSeriesForecastingSettings' => [ 'shape' => 'TimeSeriesForecastingSettings', ], 'ModelRegisterSettings' => [ 'shape' => 'ModelRegisterSettings', ], 'WorkspaceSettings' => [ 'shape' => 'WorkspaceSettings', ], ], ], 'CapacitySize' => [ 'type' => 'structure', 'required' => [ 'Type', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'CapacitySizeType', ], 'Value' => [ 'shape' => 'CapacitySizeValue', ], ], ], 'CapacitySizeType' => [ 'type' => 'string', 'enum' => [ 'INSTANCE_COUNT', 'CAPACITY_PERCENT', ], ], 'CapacitySizeValue' => [ 'type' => 'integer', 'min' => 1, ], 'CaptureContentTypeHeader' => [ 'type' => 'structure', 'members' => [ 'CsvContentTypes' => [ 'shape' => 'CsvContentTypes', ], 'JsonContentTypes' => [ 'shape' => 'JsonContentTypes', ], ], ], 'CaptureMode' => [ 'type' => 'string', 'enum' => [ 'Input', 'Output', ], ], 'CaptureOption' => [ 'type' => 'structure', 'required' => [ 'CaptureMode', ], 'members' => [ 'CaptureMode' => [ 'shape' => 'CaptureMode', ], ], ], 'CaptureOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptureOption', ], 'max' => 2, 'min' => 1, ], 'CaptureStatus' => [ 'type' => 'string', 'enum' => [ 'Started', 'Stopped', ], ], 'Catalog' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'CategoricalParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String64', ], 'Value' => [ 'shape' => 'CategoricalParameterRangeValues', ], ], ], 'CategoricalParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'Values', ], 'members' => [ 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String128', ], 'max' => 3, 'min' => 1, ], 'CategoricalParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameterRange', ], 'max' => 30, 'min' => 0, ], 'CategoricalParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameter', ], 'max' => 5, 'min' => 1, ], 'Cents' => [ 'type' => 'integer', 'max' => 99, 'min' => 0, ], 'CertifyForMarketplace' => [ 'type' => 'boolean', ], 'Channel' => [ 'type' => 'structure', 'required' => [ 'ChannelName', 'DataSource', ], 'members' => [ 'ChannelName' => [ 'shape' => 'ChannelName', ], 'DataSource' => [ 'shape' => 'DataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'RecordWrapperType' => [ 'shape' => 'RecordWrapper', ], 'InputMode' => [ 'shape' => 'TrainingInputMode', ], 'ShuffleConfig' => [ 'shape' => 'ShuffleConfig', ], ], ], 'ChannelName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9\\.\\-_]+', ], 'ChannelSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'SupportedContentTypes', 'SupportedInputModes', ], 'members' => [ 'Name' => [ 'shape' => 'ChannelName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedCompressionTypes' => [ 'shape' => 'CompressionTypes', ], 'SupportedInputModes' => [ 'shape' => 'InputModes', ], ], ], 'ChannelSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelSpecification', ], 'max' => 8, 'min' => 1, ], 'CheckpointConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'Cidr' => [ 'type' => 'string', 'max' => 64, 'min' => 4, 'pattern' => '(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)', ], 'Cidrs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cidr', ], ], 'ClarifyCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'ClarifyContentTemplate' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyEnableExplanations' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyExplainerConfig' => [ 'type' => 'structure', 'required' => [ 'ShapConfig', ], 'members' => [ 'EnableExplanations' => [ 'shape' => 'ClarifyEnableExplanations', ], 'InferenceConfig' => [ 'shape' => 'ClarifyInferenceConfig', ], 'ShapConfig' => [ 'shape' => 'ClarifyShapConfig', ], ], ], 'ClarifyFeatureHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeatureType' => [ 'type' => 'string', 'enum' => [ 'numerical', 'categorical', 'text', ], ], 'ClarifyFeatureTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyFeatureType', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeaturesAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyHeader' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyInferenceConfig' => [ 'type' => 'structure', 'members' => [ 'FeaturesAttribute' => [ 'shape' => 'ClarifyFeaturesAttribute', ], 'ContentTemplate' => [ 'shape' => 'ClarifyContentTemplate', ], 'MaxRecordCount' => [ 'shape' => 'ClarifyMaxRecordCount', ], 'MaxPayloadInMB' => [ 'shape' => 'ClarifyMaxPayloadInMB', ], 'ProbabilityIndex' => [ 'shape' => 'ClarifyProbabilityIndex', ], 'LabelIndex' => [ 'shape' => 'ClarifyLabelIndex', ], 'ProbabilityAttribute' => [ 'shape' => 'ClarifyProbabilityAttribute', ], 'LabelAttribute' => [ 'shape' => 'ClarifyLabelAttribute', ], 'LabelHeaders' => [ 'shape' => 'ClarifyLabelHeaders', ], 'FeatureHeaders' => [ 'shape' => 'ClarifyFeatureHeaders', ], 'FeatureTypes' => [ 'shape' => 'ClarifyFeatureTypes', ], ], ], 'ClarifyLabelAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyLabelHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 16, 'min' => 1, ], 'ClarifyLabelIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyMaxPayloadInMB' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'ClarifyMaxRecordCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyMimeType' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*', ], 'ClarifyProbabilityAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyProbabilityIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyShapBaseline' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'ClarifyShapBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'MimeType' => [ 'shape' => 'ClarifyMimeType', ], 'ShapBaseline' => [ 'shape' => 'ClarifyShapBaseline', ], 'ShapBaselineUri' => [ 'shape' => 'Url', ], ], ], 'ClarifyShapConfig' => [ 'type' => 'structure', 'required' => [ 'ShapBaselineConfig', ], 'members' => [ 'ShapBaselineConfig' => [ 'shape' => 'ClarifyShapBaselineConfig', ], 'NumberOfSamples' => [ 'shape' => 'ClarifyShapNumberOfSamples', ], 'UseLogit' => [ 'shape' => 'ClarifyShapUseLogit', ], 'Seed' => [ 'shape' => 'ClarifyShapSeed', ], 'TextConfig' => [ 'shape' => 'ClarifyTextConfig', ], ], ], 'ClarifyShapNumberOfSamples' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyShapSeed' => [ 'type' => 'integer', ], 'ClarifyShapUseLogit' => [ 'type' => 'boolean', ], 'ClarifyTextConfig' => [ 'type' => 'structure', 'required' => [ 'Language', 'Granularity', ], 'members' => [ 'Language' => [ 'shape' => 'ClarifyTextLanguage', ], 'Granularity' => [ 'shape' => 'ClarifyTextGranularity', ], ], ], 'ClarifyTextGranularity' => [ 'type' => 'string', 'enum' => [ 'token', 'sentence', 'paragraph', ], ], 'ClarifyTextLanguage' => [ 'type' => 'string', 'enum' => [ 'af', 'sq', 'ar', 'hy', 'eu', 'bn', 'bg', 'ca', 'zh', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fi', 'fr', 'de', 'el', 'gu', 'he', 'hi', 'hu', 'is', 'id', 'ga', 'it', 'kn', 'ky', 'lv', 'lt', 'lb', 'mk', 'ml', 'mr', 'ne', 'nb', 'fa', 'pl', 'pt', 'ro', 'ru', 'sa', 'sr', 'tn', 'si', 'sk', 'sl', 'es', 'sv', 'tl', 'ta', 'tt', 'te', 'tr', 'uk', 'ur', 'yo', 'lij', 'xx', ], ], 'ClientId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', ], 'ClientSecret' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', 'sensitive' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'CodeRepositories' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepository', ], 'max' => 10, ], 'CodeRepository' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'RepositoryUrl', ], ], ], 'CodeRepositoryArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:code-repository/.*', ], 'CodeRepositoryContains' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameOrUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'CodeRepositorySortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'CodeRepositorySortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'CodeRepositorySummary' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'CodeRepositorySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositorySummary', ], ], 'CognitoConfig' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoMemberDefinition' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'UserGroup', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'UserGroup' => [ 'shape' => 'CognitoUserGroup', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoUserGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'CognitoUserPool' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'CollectionConfiguration' => [ 'type' => 'structure', 'members' => [ 'CollectionName' => [ 'shape' => 'CollectionName', ], 'CollectionParameters' => [ 'shape' => 'CollectionParameters', ], ], ], 'CollectionConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'CollectionConfiguration', ], 'max' => 20, 'min' => 0, ], 'CollectionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'CollectionParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'CompilationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*', ], 'CompilationJobStatus' => [ 'type' => 'string', 'enum' => [ 'INPROGRESS', 'COMPLETED', 'FAILED', 'STARTING', 'STOPPING', 'STOPPED', ], ], 'CompilationJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompilationJobSummary', ], ], 'CompilationJobSummary' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CreationTime', 'CompilationJobStatus', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'CompilationTargetDevice' => [ 'shape' => 'TargetDevice', ], 'CompilationTargetPlatformOs' => [ 'shape' => 'TargetPlatformOs', ], 'CompilationTargetPlatformArch' => [ 'shape' => 'TargetPlatformArch', ], 'CompilationTargetPlatformAccelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], ], ], 'CompilerOptions' => [ 'type' => 'string', 'max' => 1024, 'min' => 3, 'pattern' => '.*', ], 'CompleteOnConvergence' => [ 'type' => 'string', 'enum' => [ 'Disabled', 'Enabled', ], ], 'CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'CompressionTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompressionType', ], ], 'ConditionOutcome' => [ 'type' => 'string', 'enum' => [ 'True', 'False', ], ], 'ConditionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Outcome' => [ 'shape' => 'ConditionOutcome', ], ], ], 'ConfigKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'ConfigValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 100, 'min' => 1, ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageConfig' => [ 'shape' => 'ImageConfig', ], 'Mode' => [ 'shape' => 'ContainerMode', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'MultiModelConfig' => [ 'shape' => 'MultiModelConfig', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], ], ], 'ContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], 'max' => 15, ], 'ContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'ContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerHostname' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ContainerImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '[\\S]+', ], 'ContainerMode' => [ 'type' => 'string', 'enum' => [ 'SingleModel', 'MultiModel', ], ], 'ContentClassifier' => [ 'type' => 'string', 'enum' => [ 'FreeOfPersonallyIdentifiableInformation', 'FreeOfAdultContent', ], ], 'ContentClassifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentClassifier', ], 'max' => 256, ], 'ContentColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContentDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentType', ], ], 'ContextArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/.*', ], 'ContextSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'String2048', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ContextSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContextSummary', ], ], 'ContextSummary' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ContinuousParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'ContinuousParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'ContinuousParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousParameterRange', ], 'max' => 30, 'min' => 0, ], 'ConvergenceDetected' => [ 'type' => 'structure', 'members' => [ 'CompleteOnConvergence' => [ 'shape' => 'CompleteOnConvergence', ], ], ], 'CreateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', 'Source', 'ActionType', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'CreateAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'TrainingSpecification', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmArn', ], 'members' => [ 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], ], ], 'CreateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'Tags' => [ 'shape' => 'TagList', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], ], ], 'CreateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'CreateAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'CreateAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], ], ], 'CreateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'Source', 'ArtifactType', ], 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'CreateAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], ], ], 'CreateAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'AutoMLProblemTypeConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], ], ], 'CreateAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'GitConfig', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'CreateCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'RoleArn', 'OutputConfig', 'StoppingCondition', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobArn', ], 'members' => [ 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], ], ], 'CreateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', 'Source', 'ContextType', ], 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'CreateDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'AuthMode', 'DefaultUserSettings', 'SubnetIds', 'VpcId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'Tags' => [ 'shape' => 'TagList', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'CreateEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], ], ], 'CreateEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], ], ], 'CreateEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', 'CompilationJobName', 'ModelName', 'ModelVersion', 'RoleArn', 'OutputConfig', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'ProductionVariants', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], ], ], 'CreateEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigArn', ], 'members' => [ 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], ], ], 'CreateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'CreateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'CreateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'CreateFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'HumanLoopConfig', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], ], ], 'CreateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubDescription', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'CreateHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'UiTemplate', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'CreateHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobConfig', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'Autotune' => [ 'shape' => 'Autotune', ], ], ], 'CreateHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobArn', ], 'members' => [ 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'CreateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'RoleArn', ], 'members' => [ 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'CreateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'BaseImage', 'ClientToken', 'ImageName', ], 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ImageName' => [ 'shape' => 'ImageName', ], 'Aliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'CreateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'CreateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'RoleArn', 'EndpointName', 'ModelVariants', 'ShadowModeConfig', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'CreateInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'RoleArn', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'OutputConfig' => [ 'shape' => 'RecommendationJobOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobArn', ], 'members' => [ 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], ], ], 'CreateLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelAttributeName', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobArn', ], 'members' => [ 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], ], ], 'CreateModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardExportJobName', 'OutputConfig', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], ], ], 'CreateModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'CreateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'Content', 'ModelCardStatus', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ExecutionRoleArn', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelArn', ], 'members' => [ 'ModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'CreateModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'CreateModelPackageInput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], ], ], 'CreateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'CreateModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'CreateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'InstanceType', 'RoleArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], ], ], 'CreateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], ], ], 'CreatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', 'RoleArn', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'CreatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'CreatePresignedDomainUrlRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], 'ExpiresInSeconds' => [ 'shape' => 'ExpiresInSeconds', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'CreatePresignedDomainUrlResponse' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'PresignedDomainUrl', ], ], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], ], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'NotebookInstanceUrl', ], ], ], 'CreateProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'RoleArn', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobArn', ], 'members' => [ 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'CreateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ServiceCatalogProvisioningDetails', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectId', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], ], ], 'CreateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], ], ], 'CreateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'CreateStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', 'StudioLifecycleConfigContent', 'StudioLifecycleConfigAppType', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'CreateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], ], ], 'CreateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'CreateTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'ModelName', 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobArn', ], 'members' => [ 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], ], ], 'CreateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'CreateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', 'ExperimentName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'CreateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'Tags' => [ 'shape' => 'TagList', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'CreateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'CreateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'CreateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'WorkforceArn', ], 'members' => [ 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], ], ], 'CreateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateWorkteamResponse' => [ 'type' => 'structure', 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'CreationTime' => [ 'type' => 'timestamp', ], 'CrossAccountFilterOption' => [ 'type' => 'string', 'enum' => [ 'SameAccount', 'CrossAccount', ], ], 'CsvContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'CsvContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CsvContentType', ], 'max' => 10, 'min' => 1, ], 'CustomImage' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'AppImageConfigName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageVersionNumber' => [ 'shape' => 'ImageVersionNumber', 'box' => true, ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'CustomImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomImage', ], 'max' => 200, ], 'CustomerMetadataKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}', ], 'CustomerMetadataKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerMetadataKey', ], ], 'CustomerMetadataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CustomerMetadataKey', ], 'value' => [ 'shape' => 'CustomerMetadataValue', ], 'max' => 50, 'min' => 1, ], 'CustomerMetadataValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}', ], 'DataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'InitialSamplingPercentage', 'DestinationS3Uri', 'CaptureOptions', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'InitialSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CaptureOptions' => [ 'shape' => 'CaptureOptionList', ], 'CaptureContentTypeHeader' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'DataCaptureConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EnableCapture', 'CaptureStatus', 'CurrentSamplingPercentage', 'DestinationS3Uri', 'KmsKeyId', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'CaptureStatus' => [ 'shape' => 'CaptureStatus', ], 'CurrentSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'DataCatalogConfig' => [ 'type' => 'structure', 'required' => [ 'TableName', 'Catalog', 'Database', ], 'members' => [ 'TableName' => [ 'shape' => 'TableName', ], 'Catalog' => [ 'shape' => 'Catalog', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'DataExplorationNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'DataInputConfig' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DataProcessing' => [ 'type' => 'structure', 'members' => [ 'InputFilter' => [ 'shape' => 'JsonPath', ], 'OutputFilter' => [ 'shape' => 'JsonPath', ], 'JoinSource' => [ 'shape' => 'JoinSource', ], ], ], 'DataQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'DataQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'DataQualityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3DataSource', ], 'FileSystemDataSource' => [ 'shape' => 'FileSystemDataSource', ], ], ], 'Database' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'DatasetDefinition' => [ 'type' => 'structure', 'members' => [ 'AthenaDatasetDefinition' => [ 'shape' => 'AthenaDatasetDefinition', ], 'RedshiftDatasetDefinition' => [ 'shape' => 'RedshiftDatasetDefinition', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'DataDistributionType' => [ 'shape' => 'DataDistributionType', ], 'InputMode' => [ 'shape' => 'InputMode', ], ], ], 'DebugHookConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'HookParameters' => [ 'shape' => 'HookParameters', ], 'CollectionConfigurations' => [ 'shape' => 'CollectionConfigurations', ], ], ], 'DebugRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'DebugRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'DebugRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DebugRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'DefaultGid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DefaultSpaceSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], ], ], 'DefaultUid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DeleteActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'DeleteAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DeleteAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DeleteArtifactRequest' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], ], ], 'DeleteArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DeleteAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'RetentionPolicy' => [ 'shape' => 'RetentionPolicy', ], ], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DeleteEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DeleteExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'DeleteFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'DeleteFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DeleteFlowDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', 'HubContentVersion', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DeleteHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DeleteHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DeleteHumanTaskUiResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DeleteImageResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DeleteImageVersionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DeleteInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DeleteModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DeleteModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DeleteNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DeletePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'DeletePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'DeleteProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DeleteSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DeleteStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DeleteTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'DeleteTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'DeleteTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DeleteUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DeleteWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DeleteWorkforceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DeleteWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Success', ], 'members' => [ 'Success' => [ 'shape' => 'Success', ], ], ], 'DependencyCopyPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DependencyOriginPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DeployedImage' => [ 'type' => 'structure', 'members' => [ 'SpecifiedImage' => [ 'shape' => 'ContainerImage', ], 'ResolvedImage' => [ 'shape' => 'ContainerImage', ], 'ResolutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeployedImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeployedImage', ], ], 'DeploymentConfig' => [ 'type' => 'structure', 'members' => [ 'BlueGreenUpdatePolicy' => [ 'shape' => 'BlueGreenUpdatePolicy', ], 'AutoRollbackConfiguration' => [ 'shape' => 'AutoRollbackConfig', ], 'RollingUpdatePolicy' => [ 'shape' => 'RollingUpdatePolicy', ], ], ], 'DeploymentRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationStatus', ], 'members' => [ 'RecommendationStatus' => [ 'shape' => 'RecommendationStatus', ], 'RealTimeInferenceRecommendations' => [ 'shape' => 'RealTimeInferenceRecommendations', ], ], ], 'DeploymentStage' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], ], ], 'DeploymentStageMaxResults' => [ 'type' => 'integer', 'max' => 10, ], 'DeploymentStageStatusSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStageStatusSummary', ], ], 'DeploymentStageStatusSummary' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', 'DeploymentConfig', 'DeploymentStatus', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], 'DeploymentStatus' => [ 'shape' => 'EdgeDeploymentStatus', ], ], ], 'DeploymentStages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStage', ], ], 'DeregisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceNames', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], ], ], 'DescribeActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ActionArn' => [ 'shape' => 'ActionArn', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'TrainingSpecification', 'AlgorithmStatus', 'AlgorithmStatusDetails', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], 'AlgorithmStatusDetails' => [ 'shape' => 'AlgorithmStatusDetails', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], ], ], 'DescribeAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DescribeAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], ], ], 'DescribeAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'LastHealthCheckTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUserActivityTimestamp' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DescribeArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'ResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], ], ], 'DescribeAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'AutoMLResolvedAttributes', ], 'AutoMLProblemTypeConfigName' => [ 'shape' => 'AutoMLProblemTypeConfigName', ], ], ], 'DescribeCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'DescribeCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CompilationJobStatus', 'StoppingCondition', 'CreationTime', 'LastModifiedTime', 'FailureReason', 'ModelArtifacts', 'RoleArn', 'InputConfig', 'OutputConfig', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'InferenceImage' => [ 'shape' => 'InferenceImage', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'ModelDigests' => [ 'shape' => 'ModelDigests', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], ], ], 'DescribeContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], 'ContextArn' => [ 'shape' => 'ContextArn', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceFleetResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceFleetArn', 'OutputConfig', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'IotRoleAlias' => [ 'shape' => 'IotRoleAlias', ], ], ], 'DescribeDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', 'RegistrationTime', ], 'members' => [ 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModels', ], 'MaxModels' => [ 'shape' => 'Integer', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'HomeEfsFileSystemId' => [ 'shape' => 'ResourceId', ], 'SingleSignOnManagedApplicationInstanceId' => [ 'shape' => 'String256', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'Url' => [ 'shape' => 'String1024', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'SecurityGroupIdForDomainBoundary' => [ 'shape' => 'SecurityGroupId', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'DeploymentStageMaxResults', ], ], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'Stages' => [ 'shape' => 'DeploymentStageStatusSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeEdgePackagingJobResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'EdgePackagingJobStatusMessage' => [ 'shape' => 'String', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ModelArtifact' => [ 'shape' => 'S3Uri', ], 'ModelSignature' => [ 'shape' => 'String', ], 'PresetDeploymentOutput' => [ 'shape' => 'EdgePresetDeploymentOutput', ], ], ], 'DescribeEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DescribeEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'ProductionVariants', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], ], ], 'DescribeEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DescribeEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointConfigName', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastDeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'PendingDeploymentSummary' => [ 'shape' => 'PendingDeploymentSummary', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'DescribeExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', 'CreationTime', 'NextToken', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'OnlineStoreTotalSizeBytes' => [ 'shape' => 'OnlineStoreTotalSizeBytes', ], ], ], 'DescribeFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], ], ], 'DescribeFeatureMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'FeatureName', 'FeatureType', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'DescribeFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DescribeFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', 'FlowDefinitionName', 'FlowDefinitionStatus', 'CreationTime', 'HumanLoopConfig', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DescribeHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DescribeHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubArn', 'HubContentDocument', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentDependencies' => [ 'shape' => 'HubContentDependencyList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DescribeHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DescribeHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', 'HumanTaskUiName', 'CreationTime', 'UiTemplate', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiStatus' => [ 'shape' => 'HumanTaskUiStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'UiTemplate' => [ 'shape' => 'UiTemplateInfo', ], ], ], 'DescribeHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'DescribeHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobConfig', 'HyperParameterTuningJobStatus', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], 'Autotune' => [ 'shape' => 'Autotune', ], ], ], 'DescribeImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DescribeImageResponse' => [ 'type' => 'structure', 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'DescribeImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DescribeImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ContainerImage' => [ 'shape' => 'ImageContainerImage', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'DescribeInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DescribeInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Name', 'Type', 'Status', 'EndpointMetadata', 'ModelVariants', ], 'members' => [ 'Arn' => [ 'shape' => 'InferenceExperimentArn', ], 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointMetadata' => [ 'shape' => 'EndpointMetadata', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigSummaryList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], ], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'JobArn', 'RoleArn', 'Status', 'CreationTime', 'LastModifiedTime', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'InferenceRecommendations' => [ 'shape' => 'InferenceRecommendations', ], 'EndpointPerformances' => [ 'shape' => 'EndpointPerformances', ], ], ], 'DescribeLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'DescribeLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobStatus', 'LabelCounters', 'CreationTime', 'LastModifiedTime', 'JobReferenceCode', 'LabelingJobName', 'LabelingJobArn', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], ], ], 'DescribeLineageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeLineageGroupResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'DescribeModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'OutputConfig', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExportArtifacts' => [ 'shape' => 'ModelCardExportArtifacts', ], ], ], 'DescribeModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], ], ], 'DescribeModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', 'ModelCardName', 'ModelCardVersion', 'Content', 'ModelCardStatus', 'CreationTime', 'CreatedBy', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ModelCardProcessingStatus' => [ 'shape' => 'ModelCardProcessingStatus', ], ], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DescribeModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ExecutionRoleArn', 'CreationTime', 'ModelArn', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'DescribeModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'CreatedBy', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'DescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DescribeModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', 'ModelPackageStatusDetails', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], ], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DescribeMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', 'MonitoringScheduleName', 'MonitoringScheduleStatus', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], ], ], 'DescribeNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], ], ], 'DescribeNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'NetworkInterfaceId' => [ 'shape' => 'NetworkInterfaceId', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'DescribePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], ], ], 'DescribePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'DescribeProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'DescribeProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'ProcessingJobArn', 'ProcessingJobStatus', 'CreationTime', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'DescribeProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DescribeProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectName', 'ProjectId', 'ServiceCatalogProvisioningDetails', 'ProjectStatus', 'CreationTime', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceArn' => [ 'shape' => 'SpaceArn', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], ], ], 'DescribeStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DescribeStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'DescribeSubscribedWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'DescribeSubscribedWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteam', ], 'members' => [ 'SubscribedWorkteam' => [ 'shape' => 'SubscribedWorkteam', ], ], ], 'DescribeTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'DescribeTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'ModelArtifacts', 'TrainingJobStatus', 'SecondaryStatus', 'AlgorithmSpecification', 'ResourceConfig', 'StoppingCondition', 'CreationTime', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ProfilerRuleEvaluationStatuses' => [ 'shape' => 'ProfilerRuleEvaluationStatuses', ], 'ProfilingStatus' => [ 'shape' => 'ProfilingStatus', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], ], ], 'DescribeTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'DescribeTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'TransformJobStatus', 'ModelName', 'TransformInput', 'TransformResources', 'CreationTime', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'DescribeTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Sources' => [ 'shape' => 'TrialComponentSources', ], ], ], 'DescribeTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], ], ], 'DescribeUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DescribeUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'DescribeWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DescribeWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'DescribeWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DescribeWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 128, ], 'DesiredWeightAndCapacity' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'ServerlessUpdateConfig' => [ 'shape' => 'ProductionVariantServerlessUpdateConfig', ], ], ], 'DesiredWeightAndCapacityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DesiredWeightAndCapacity', ], 'min' => 1, ], 'DestinationS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/])/?(.*)$', ], 'DetailedAlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'DetailedModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'DeviceName', ], 'members' => [ 'DeviceName' => [ 'shape' => 'DeviceName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'IotThingName' => [ 'shape' => 'ThingName', ], ], ], 'DeviceArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'READYTODEPLOY', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'DeviceDeploymentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceDeploymentSummary', ], ], 'DeviceDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'StageName', 'DeviceName', 'DeviceArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], 'DeployedStageName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceName' => [ 'shape' => 'DeviceName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceDeploymentStatus' => [ 'shape' => 'DeviceDeploymentStatus', ], 'DeviceDeploymentStatusMessage' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeploymentStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceDescription' => [ 'type' => 'string', 'max' => 40, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DeviceFleetArn' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceFleetDescription' => [ 'type' => 'string', 'max' => 800, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DeviceFleetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceFleetSummary', ], ], 'DeviceFleetSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'DeviceNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceName', ], ], 'DeviceSelectionConfig' => [ 'type' => 'structure', 'required' => [ 'DeviceSubsetType', ], 'members' => [ 'DeviceSubsetType' => [ 'shape' => 'DeviceSubsetType', ], 'Percentage' => [ 'shape' => 'Percentage', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], 'DeviceNameContains' => [ 'shape' => 'DeviceName', ], ], ], 'DeviceStats' => [ 'type' => 'structure', 'required' => [ 'ConnectedDeviceCount', 'RegisteredDeviceCount', ], 'members' => [ 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'RegisteredDeviceCount' => [ 'shape' => 'Long', ], ], ], 'DeviceSubsetType' => [ 'type' => 'string', 'enum' => [ 'PERCENTAGE', 'SELECTION', 'NAMECONTAINS', ], ], 'DeviceSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceSummary', ], ], 'DeviceSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceArn', ], 'members' => [ 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModelSummaries', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'Devices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'DirectInternetAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Direction' => [ 'type' => 'string', 'enum' => [ 'Both', 'Ascendants', 'Descendants', ], ], 'DirectoryPath' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'DisableProfiler' => [ 'type' => 'boolean', ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'type' => 'boolean', ], 'DisassociateDefaultCodeRepository' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'type' => 'boolean', ], 'DisassociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DisassociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DocumentSchemaVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'Dollars' => [ 'type' => 'integer', 'max' => 2, 'min' => 0, ], 'DomainArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*', ], 'DomainDetails' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DomainId' => [ 'type' => 'string', 'max' => 63, ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainDetails', ], ], 'DomainName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'DomainSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 3, ], 'DomainSettings' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'RStudioServerProDomainSettings' => [ 'shape' => 'RStudioServerProDomainSettings', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], ], ], 'DomainSettingsForUpdate' => [ 'type' => 'structure', 'members' => [ 'RStudioServerProDomainSettingsForUpdate' => [ 'shape' => 'RStudioServerProDomainSettingsForUpdate', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], ], ], 'DomainStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'DoubleParameterValue' => [ 'type' => 'double', ], 'DriftCheckBaselines' => [ 'type' => 'structure', 'members' => [ 'Bias' => [ 'shape' => 'DriftCheckBias', ], 'Explainability' => [ 'shape' => 'DriftCheckExplainability', ], 'ModelQuality' => [ 'shape' => 'DriftCheckModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'DriftCheckModelDataQuality', ], ], ], 'DriftCheckBias' => [ 'type' => 'structure', 'members' => [ 'ConfigFile' => [ 'shape' => 'FileSource', ], 'PreTrainingConstraints' => [ 'shape' => 'MetricsSource', ], 'PostTrainingConstraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckExplainability' => [ 'type' => 'structure', 'members' => [ 'Constraints' => [ 'shape' => 'MetricsSource', ], 'ConfigFile' => [ 'shape' => 'FileSource', ], ], ], 'DriftCheckModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'EMRStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'String256', ], 'StepId' => [ 'shape' => 'String256', ], 'StepName' => [ 'shape' => 'String256', ], 'LogFilePath' => [ 'shape' => 'String1024', ], ], ], 'Edge' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'EdgeDeploymentConfig' => [ 'type' => 'structure', 'required' => [ 'FailureHandlingPolicy', ], 'members' => [ 'FailureHandlingPolicy' => [ 'shape' => 'FailureHandlingPolicy', ], ], ], 'EdgeDeploymentModelConfig' => [ 'type' => 'structure', 'required' => [ 'ModelHandle', 'EdgePackagingJobName', ], 'members' => [ 'ModelHandle' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'EdgeDeploymentModelConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentModelConfig', ], ], 'EdgeDeploymentPlanArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgeDeploymentPlanSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentPlanSummary', ], ], 'EdgeDeploymentPlanSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'DeviceFleetName', 'EdgeDeploymentSuccess', 'EdgeDeploymentPending', 'EdgeDeploymentFailed', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeDeploymentStatus' => [ 'type' => 'structure', 'required' => [ 'StageStatus', 'EdgeDeploymentSuccessInStage', 'EdgeDeploymentPendingInStage', 'EdgeDeploymentFailedInStage', ], 'members' => [ 'StageStatus' => [ 'shape' => 'StageStatus', ], 'EdgeDeploymentSuccessInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPendingInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailedInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentStatusMessage' => [ 'shape' => 'String', ], 'EdgeDeploymentStageStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModel' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'LatestSampleTime' => [ 'shape' => 'Timestamp', ], 'LatestInference' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModelStat' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', 'OfflineDeviceCount', 'ConnectedDeviceCount', 'ActiveDeviceCount', 'SamplingDeviceCount', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'OfflineDeviceCount' => [ 'shape' => 'Long', ], 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'ActiveDeviceCount' => [ 'shape' => 'Long', ], 'SamplingDeviceCount' => [ 'shape' => 'Long', ], ], ], 'EdgeModelStats' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelStat', ], ], 'EdgeModelSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelSummary', ], ], 'EdgeModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'EdgeModels' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModel', ], ], 'EdgeOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'PresetDeploymentType' => [ 'shape' => 'EdgePresetDeploymentType', ], 'PresetDeploymentConfig' => [ 'shape' => 'String', ], ], ], 'EdgePackagingJobArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgePackagingJobStatus' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'INPROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'EdgePackagingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgePackagingJobSummary', ], ], 'EdgePackagingJobSummary' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgePresetDeploymentArtifact' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'EdgePresetDeploymentOutput' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'EdgePresetDeploymentType', ], 'Artifact' => [ 'shape' => 'EdgePresetDeploymentArtifact', ], 'Status' => [ 'shape' => 'EdgePresetDeploymentStatus', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], 'EdgePresetDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'FAILED', ], ], 'EdgePresetDeploymentType' => [ 'type' => 'string', 'enum' => [ 'GreengrassV2Component', ], ], 'EdgeVersion' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\ \\_\\.]+', ], 'Edges' => [ 'type' => 'list', 'member' => [ 'shape' => 'Edge', ], ], 'EfsUid' => [ 'type' => 'string', 'max' => 10, 'pattern' => '\\d+', ], 'EnableCapture' => [ 'type' => 'boolean', ], 'EnableIotRoleAlias' => [ 'type' => 'boolean', ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'Endpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointConfigName', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringSchedules' => [ 'shape' => 'MonitoringScheduleList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'EndpointArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/.*', ], 'EndpointConfigArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/.*', ], 'EndpointConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'EndpointConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'EndpointConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointConfigSummary', ], ], 'EndpointInfo' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'EndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'LocalPath', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], ], ], 'EndpointInputConfiguration' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameterRanges' => [ 'shape' => 'EnvironmentParameterRanges', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'EndpointInputConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInputConfiguration', ], 'max' => 10, 'min' => 1, ], 'EndpointMetadata' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'EndpointName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointOutputConfiguration' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'VariantName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'String', ], 'VariantName' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialInstanceCount' => [ 'shape' => 'InitialInstanceCount', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'EndpointPerformance' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointInfo', ], 'members' => [ 'Metrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointInfo' => [ 'shape' => 'EndpointInfo', ], ], ], 'EndpointPerformances' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointPerformance', ], 'max' => 1, ], 'EndpointSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'EndpointStatus' => [ 'type' => 'string', 'enum' => [ 'OutOfService', 'Creating', 'Updating', 'SystemUpdating', 'RollingBack', 'InService', 'Deleting', 'Failed', 'UpdateRollbackFailed', ], ], 'EndpointSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'EndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointSummary', ], ], 'Endpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInfo', ], 'max' => 1, ], 'EntityDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'EntityName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'EnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'EnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'EnvironmentKey', ], 'value' => [ 'shape' => 'EnvironmentValue', ], 'max' => 16, ], 'EnvironmentParameter' => [ 'type' => 'structure', 'required' => [ 'Key', 'ValueType', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'String', ], 'ValueType' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'EnvironmentParameterRanges' => [ 'type' => 'structure', 'members' => [ 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameters', ], ], ], 'EnvironmentParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentParameter', ], 'max' => 10, 'min' => 1, ], 'EnvironmentValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'ExecutionRoleIdentityConfig' => [ 'type' => 'string', 'enum' => [ 'USER_PROFILE_NAME', 'DISABLED', ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Completed', 'CompletedWithViolations', 'InProgress', 'Failed', 'Stopping', 'Stopped', ], ], 'ExitMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'Experiment' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/.*', ], 'ExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentDisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ExperimentDescription' => [ 'type' => 'string', 'max' => 3072, 'pattern' => '.*', ], 'ExperimentEntityName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'ExperimentEntityNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'ExperimentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'ExperimentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'ExperimentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'ExperimentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExperimentSummary', ], ], 'ExperimentSummary' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentSource' => [ 'shape' => 'ExperimentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ExpiresInSeconds' => [ 'type' => 'integer', 'max' => 300, 'min' => 5, ], 'Explainability' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], ], ], 'ExplainabilityLocation' => [ 'type' => 'string', 'min' => 1, ], 'ExplainerConfig' => [ 'type' => 'structure', 'members' => [ 'ClarifyExplainerConfig' => [ 'shape' => 'ClarifyExplainerConfig', ], ], ], 'FailStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String3072', ], ], ], 'FailureHandlingPolicy' => [ 'type' => 'string', 'enum' => [ 'ROLLBACK_ON_FAILURE', 'DO_NOTHING', ], ], 'FailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'FeatureAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 100, 'min' => 1, ], 'FeatureDefinition' => [ 'type' => 'structure', 'members' => [ 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], ], ], 'FeatureDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 2500, 'min' => 1, ], 'FeatureDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '.*', ], 'FeatureGroup' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'FeatureGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/.*', ], 'FeatureGroupMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'FeatureGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}', ], 'FeatureGroupNameContains' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'FeatureGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})', ], 'FeatureGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'FeatureGroupStatus', 'OfflineStoreStatus', 'CreationTime', ], ], 'FeatureGroupSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'FeatureGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'CreateFailed', 'Deleting', 'DeleteFailed', ], ], 'FeatureGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureGroupSummary', ], ], 'FeatureGroupSummary' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureGroupArn', 'CreationTime', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], ], ], 'FeatureMetadata' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'FeatureName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}', ], 'FeatureParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'FeatureParameterKey', ], 'Value' => [ 'shape' => 'FeatureParameterValue', ], ], ], 'FeatureParameterAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, ], 'FeatureParameterKey' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameterRemovals' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameterKey', ], 'max' => 25, ], 'FeatureParameterValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, 'min' => 0, ], 'FeatureStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'FeatureType' => [ 'type' => 'string', 'enum' => [ 'Integral', 'Fractional', 'String', ], ], 'FileSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'FileSystemAccessMode' => [ 'type' => 'string', 'enum' => [ 'rw', 'ro', ], ], 'FileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'MountPath' => [ 'shape' => 'MountPath', ], 'DefaultUid' => [ 'shape' => 'DefaultUid', 'box' => true, ], 'DefaultGid' => [ 'shape' => 'DefaultGid', 'box' => true, ], ], ], 'FileSystemDataSource' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', 'FileSystemAccessMode', 'FileSystemType', 'DirectoryPath', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemAccessMode' => [ 'shape' => 'FileSystemAccessMode', ], 'FileSystemType' => [ 'shape' => 'FileSystemType', ], 'DirectoryPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'FileSystemId' => [ 'type' => 'string', 'min' => 11, 'pattern' => '.*', ], 'FileSystemType' => [ 'type' => 'string', 'enum' => [ 'EFS', 'FSxLustre', ], ], 'FillingTransformationMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FillingType', ], 'value' => [ 'shape' => 'FillingTransformationValue', ], 'max' => 6, 'min' => 1, ], 'FillingTransformationValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-]+$', ], 'FillingTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'FillingTransformationMap', ], 'max' => 50, 'min' => 1, ], 'FillingType' => [ 'type' => 'string', 'enum' => [ 'frontfill', 'middlefill', 'backfill', 'futurefill', 'frontfill_value', 'middlefill_value', 'backfill_value', 'futurefill_value', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'ResourcePropertyName', ], 'Operator' => [ 'shape' => 'Operator', ], 'Value' => [ 'shape' => 'FilterValue', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'max' => 20, 'min' => 1, ], 'FilterValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'FinalAutoMLJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'AutoMLJobObjectiveType', ], 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'MetricValue', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'MetricValue', ], ], ], 'FinalMetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricData', ], 'max' => 40, 'min' => 0, ], 'FlatInvocations' => [ 'type' => 'string', 'enum' => [ 'Continue', 'Stop', ], ], 'Float' => [ 'type' => 'float', ], 'FlowDefinitionArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:flow-definition/.*', ], 'FlowDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9]){0,62}', ], 'FlowDefinitionOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'FlowDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Active', 'Failed', 'Deleting', ], ], 'FlowDefinitionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionSummary', ], ], 'FlowDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'FlowDefinitionArn', 'FlowDefinitionStatus', 'CreationTime', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'max' => 864000, 'min' => 1, ], 'FlowDefinitionTaskCount' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'FlowDefinitionTaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'FlowDefinitionTaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'FlowDefinitionTaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionTaskKeyword', ], 'max' => 5, 'min' => 1, ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'type' => 'integer', 'max' => 28800, 'min' => 30, ], 'FlowDefinitionTaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'ForecastFrequency' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$', ], 'ForecastHorizon' => [ 'type' => 'integer', 'min' => 1, ], 'ForecastQuantile' => [ 'type' => 'string', 'max' => 4, 'min' => 2, 'pattern' => '(^p[1-9]\\d?$)', ], 'ForecastQuantiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ForecastQuantile', ], 'max' => 5, 'min' => 1, ], 'Framework' => [ 'type' => 'string', 'enum' => [ 'TENSORFLOW', 'KERAS', 'MXNET', 'ONNX', 'PYTORCH', 'XGBOOST', 'TFLITE', 'DARKNET', 'SKLEARN', ], ], 'FrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.]+', ], 'GenerateCandidateDefinitionsOnly' => [ 'type' => 'boolean', ], 'GetDeviceFleetReportRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'GetDeviceFleetReportResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'ReportGenerated' => [ 'shape' => 'Timestamp', ], 'DeviceStats' => [ 'shape' => 'DeviceStats', ], 'AgentVersions' => [ 'shape' => 'AgentVersions', ], 'ModelStats' => [ 'shape' => 'EdgeModelStats', ], ], ], 'GetLineageGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'LineageGroupNameOrArn', ], ], ], 'GetLineageGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'ResourcePolicy' => [ 'shape' => 'ResourcePolicyString', ], ], ], 'GetModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'GetModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ResourcePolicy', ], 'members' => [ 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'type' => 'structure', 'members' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'SagemakerServicecatalogStatus', ], ], ], 'GetSearchSuggestionsRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SuggestionQuery' => [ 'shape' => 'SuggestionQuery', ], ], ], 'GetSearchSuggestionsResponse' => [ 'type' => 'structure', 'members' => [ 'PropertyNameSuggestions' => [ 'shape' => 'PropertyNameSuggestionList', ], ], ], 'GitConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'GitConfigUrl', ], 'Branch' => [ 'shape' => 'Branch', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigUrl' => [ 'type' => 'string', 'pattern' => '^https://([^/]+)/?(.*)$', ], 'Group' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'GroupingAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'GroupingAttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupingAttributeName', ], 'max' => 5, 'min' => 1, ], 'Groups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], 'max' => 10, 'min' => 1, ], 'HookParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'Horovod' => [ 'type' => 'boolean', ], 'HubArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDependency' => [ 'type' => 'structure', 'members' => [ 'DependencyOriginPath' => [ 'shape' => 'DependencyOriginPath', ], 'DependencyCopyPath' => [ 'shape' => 'DependencyCopyPath', ], ], ], 'HubContentDependencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentDependency', ], 'max' => 50, ], 'HubContentDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubContentDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDocument' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentInfo' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubContentInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentInfo', ], ], 'HubContentMarkdown' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubContentSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubContentSortBy' => [ 'type' => 'string', 'enum' => [ 'HubContentName', 'CreationTime', 'HubContentStatus', ], ], 'HubContentStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Importing', 'Deleting', 'ImportFailed', 'DeleteFailed', ], ], 'HubContentType' => [ 'type' => 'string', 'enum' => [ 'Model', 'Notebook', ], ], 'HubContentVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'HubDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubInfo' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubInfo', ], ], 'HubName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubS3StorageConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3OutputPath', ], ], ], 'HubSearchKeyword' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[^A-Z]*$', ], 'HubSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubSortBy' => [ 'type' => 'string', 'enum' => [ 'HubName', 'CreationTime', 'HubStatus', 'AccountIdOwner', ], ], 'HubStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Deleting', 'CreateFailed', 'UpdateFailed', 'DeleteFailed', ], ], 'HumanLoopActivationConditions' => [ 'type' => 'string', 'max' => 10240, ], 'HumanLoopActivationConditionsConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditions', ], 'members' => [ 'HumanLoopActivationConditions' => [ 'shape' => 'HumanLoopActivationConditions', 'jsonvalue' => true, ], ], ], 'HumanLoopActivationConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditionsConfig', ], 'members' => [ 'HumanLoopActivationConditionsConfig' => [ 'shape' => 'HumanLoopActivationConditionsConfig', ], ], ], 'HumanLoopConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'HumanTaskUiArn', 'TaskTitle', 'TaskDescription', 'TaskCount', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'TaskTitle' => [ 'shape' => 'FlowDefinitionTaskTitle', ], 'TaskDescription' => [ 'shape' => 'FlowDefinitionTaskDescription', ], 'TaskCount' => [ 'shape' => 'FlowDefinitionTaskCount', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'FlowDefinitionTaskAvailabilityLifetimeInSeconds', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'FlowDefinitionTaskTimeLimitInSeconds', ], 'TaskKeywords' => [ 'shape' => 'FlowDefinitionTaskKeywords', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanLoopRequestSource' => [ 'type' => 'structure', 'required' => [ 'AwsManagedHumanLoopRequestSource', ], 'members' => [ 'AwsManagedHumanLoopRequestSource' => [ 'shape' => 'AwsManagedHumanLoopRequestSource', ], ], ], 'HumanTaskConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'UiConfig', 'PreHumanTaskLambdaArn', 'TaskTitle', 'TaskDescription', 'NumberOfHumanWorkersPerDataObject', 'TaskTimeLimitInSeconds', 'AnnotationConsolidationConfig', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'UiConfig' => [ 'shape' => 'UiConfig', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'TaskKeywords' => [ 'shape' => 'TaskKeywords', ], 'TaskTitle' => [ 'shape' => 'TaskTitle', ], 'TaskDescription' => [ 'shape' => 'TaskDescription', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'TaskTimeLimitInSeconds', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'TaskAvailabilityLifetimeInSeconds', ], 'MaxConcurrentTaskCount' => [ 'shape' => 'MaxConcurrentTaskCount', ], 'AnnotationConsolidationConfig' => [ 'shape' => 'AnnotationConsolidationConfig', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanTaskUiArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:human-task-ui/.*', ], 'HumanTaskUiName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9])*', ], 'HumanTaskUiStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'HumanTaskUiSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HumanTaskUiSummary', ], ], 'HumanTaskUiSummary' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'HumanTaskUiArn', 'CreationTime', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], ], ], 'HyperParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'HyperParameterScalingType' => [ 'type' => 'string', 'enum' => [ 'Auto', 'Linear', 'Logarithmic', 'ReverseLogarithmic', ], ], 'HyperParameterSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Type' => [ 'shape' => 'ParameterType', ], 'Range' => [ 'shape' => 'ParameterRange', ], 'IsTunable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'DefaultValue' => [ 'shape' => 'HyperParameterValue', ], ], ], 'HyperParameterSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterSpecification', ], 'max' => 100, 'min' => 0, ], 'HyperParameterTrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'StoppingCondition', ], 'members' => [ 'DefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TuningObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'HyperParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'StaticHyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'HyperParameterAlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'HyperParameterTuningResourceConfig' => [ 'shape' => 'HyperParameterTuningResourceConfig', ], 'Environment' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentMap', ], ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'HyperParameterTrainingJobDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'max' => 10, 'min' => 1, ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentKey', ], 'value' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentValue', ], 'max' => 48, ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'HyperParameterTrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], ], 'HyperParameterTrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', 'TunedHyperParameters', ], 'members' => [ 'TrainingJobDefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'TunedHyperParameters' => [ 'shape' => 'HyperParameters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'shape' => 'FinalHyperParameterTuningJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], ], ], 'HyperParameterTuningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'Prioritized', ], ], 'HyperParameterTuningInstanceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], ], ], 'HyperParameterTuningInstanceConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningInstanceConfig', ], 'max' => 6, 'min' => 1, ], 'HyperParameterTuningJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*', ], 'HyperParameterTuningJobCompletionDetails' => [ 'type' => 'structure', 'members' => [ 'NumberOfTrainingJobsObjectiveNotImproving' => [ 'shape' => 'Integer', ], 'ConvergenceDetectedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterTuningJobConfig' => [ 'type' => 'structure', 'required' => [ 'Strategy', 'ResourceLimits', ], 'members' => [ 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'StrategyConfig' => [ 'shape' => 'HyperParameterTuningJobStrategyConfig', ], 'HyperParameterTuningJobObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], 'ParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'TrainingJobEarlyStoppingType' => [ 'shape' => 'TrainingJobEarlyStoppingType', ], 'TuningJobCompletionCriteria' => [ 'shape' => 'TuningJobCompletionCriteria', ], 'RandomSeed' => [ 'shape' => 'RandomSeed', ], ], ], 'HyperParameterTuningJobConsumedResources' => [ 'type' => 'structure', 'members' => [ 'RuntimeInSeconds' => [ 'shape' => 'Integer', ], ], ], 'HyperParameterTuningJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'HyperParameterTuningJobObjective' => [ 'type' => 'structure', 'required' => [ 'Type', 'MetricName', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], ], ], 'HyperParameterTuningJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'HyperParameterTuningJobObjectives' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobObjective', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Tags' => [ 'shape' => 'TagList', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], ], ], 'HyperParameterTuningJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'Status', 'CreationTime', ], ], 'HyperParameterTuningJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'HyperbandStrategyConfig' => [ 'shape' => 'HyperbandStrategyConfig', ], ], ], 'HyperParameterTuningJobStrategyType' => [ 'type' => 'string', 'enum' => [ 'Bayesian', 'Random', 'Hyperband', 'Grid', ], ], 'HyperParameterTuningJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobSummary', ], ], 'HyperParameterTuningJobSummary' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobStatus', 'Strategy', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'type' => 'structure', 'required' => [ 'ParentHyperParameterTuningJobs', 'WarmStartType', ], 'members' => [ 'ParentHyperParameterTuningJobs' => [ 'shape' => 'ParentHyperParameterTuningJobs', ], 'WarmStartType' => [ 'shape' => 'HyperParameterTuningJobWarmStartType', ], ], ], 'HyperParameterTuningJobWarmStartType' => [ 'type' => 'string', 'enum' => [ 'IdenticalDataAndAlgorithm', 'TransferLearning', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 15768000, 'min' => 120, ], 'HyperParameterTuningResourceConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AllocationStrategy' => [ 'shape' => 'HyperParameterTuningAllocationStrategy', ], 'InstanceConfigs' => [ 'shape' => 'HyperParameterTuningInstanceConfigs', ], ], ], 'HyperParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'HyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterKey', ], 'value' => [ 'shape' => 'HyperParameterValue', ], 'max' => 100, 'min' => 0, ], 'HyperbandStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'MinResource' => [ 'shape' => 'HyperbandStrategyMinResource', ], 'MaxResource' => [ 'shape' => 'HyperbandStrategyMaxResource', ], ], ], 'HyperbandStrategyMaxResource' => [ 'type' => 'integer', 'min' => 1, ], 'HyperbandStrategyMinResource' => [ 'type' => 'integer', 'min' => 1, ], 'IamIdentity' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String', ], 'PrincipalId' => [ 'shape' => 'String', ], 'SourceIdentity' => [ 'shape' => 'String', ], ], ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 128, 'min' => 32, ], 'Image' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageName', 'ImageStatus', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ImageArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$', ], 'ImageBaseImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'ImageClassificationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ImageConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryAccessMode', ], 'members' => [ 'RepositoryAccessMode' => [ 'shape' => 'RepositoryAccessMode', ], 'RepositoryAuthConfig' => [ 'shape' => 'RepositoryAuthConfig', ], ], ], 'ImageContainerImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ImageDeleteProperty' => [ 'type' => 'string', 'max' => 11, 'min' => 1, 'pattern' => '(^DisplayName$)|(^Description$)', ], 'ImageDeletePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageDeleteProperty', ], 'max' => 2, ], 'ImageDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*', ], 'ImageDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ImageDisplayName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^\\S(.*\\S)?$', ], 'ImageName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$', ], 'ImageNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9\\-.]+$', ], 'ImageSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'IMAGE_NAME', ], ], 'ImageSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageUri' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'ImageVersion' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageVersionArn', 'ImageVersionStatus', 'LastModifiedTime', 'Version', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], ], ], 'ImageVersionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$', ], 'ImageVersionNumber' => [ 'type' => 'integer', 'min' => 0, ], 'ImageVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'VERSION', ], ], 'ImageVersionSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageVersionStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageVersion', ], ], 'Images' => [ 'type' => 'list', 'member' => [ 'shape' => 'Image', ], ], 'ImportHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubContentDocument', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ImportHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', 'HubContentArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], ], ], 'InferenceExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'InferenceExecutionMode', ], ], ], 'InferenceExecutionMode' => [ 'type' => 'string', 'enum' => [ 'Serial', 'Direct', ], ], 'InferenceExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/.*', ], 'InferenceExperimentDataStorageConfig' => [ 'type' => 'structure', 'required' => [ 'Destination', ], 'members' => [ 'Destination' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'ContentType' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'InferenceExperimentDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceExperimentSummary', ], ], 'InferenceExperimentName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'InferenceExperimentSchedule' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceExperimentStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'Updating', 'Running', 'Starting', 'Stopping', 'Completed', 'Cancelled', ], ], 'InferenceExperimentStatusReason' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentStopDesiredState' => [ 'type' => 'string', 'enum' => [ 'Completed', 'Cancelled', ], ], 'InferenceExperimentSummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'Status', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'InferenceExperimentType' => [ 'type' => 'string', 'enum' => [ 'ShadowMode', ], ], 'InferenceImage' => [ 'type' => 'string', 'max' => 256, ], 'InferenceMetrics' => [ 'type' => 'structure', 'required' => [ 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'InferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointConfiguration', 'ModelConfiguration', ], 'members' => [ 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'RecommendationId' => [ 'shape' => 'String', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'InferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendation', ], 'max' => 10, 'min' => 1, ], 'InferenceRecommendationsJob' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobDescription', 'JobType', 'JobArn', 'Status', 'CreationTime', 'RoleArn', 'LastModifiedTime', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'InferenceRecommendationsJobStep' => [ 'type' => 'structure', 'required' => [ 'StepType', 'JobName', 'Status', ], 'members' => [ 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'InferenceBenchmark' => [ 'shape' => 'RecommendationJobInferenceBenchmark', ], ], ], 'InferenceRecommendationsJobSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJobStep', ], ], 'InferenceRecommendationsJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJob', ], ], 'InferenceSpecification' => [ 'type' => 'structure', 'required' => [ 'Containers', 'SupportedContentTypes', 'SupportedResponseMIMETypes', ], 'members' => [ 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'InferenceSpecificationName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'InitialInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InitialNumberOfUsers' => [ 'type' => 'integer', 'min' => 1, ], 'InitialTaskCount' => [ 'type' => 'integer', 'min' => 1, ], 'InputConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'DataInputConfig', 'Framework', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], 'Framework' => [ 'shape' => 'Framework', ], 'FrameworkVersion' => [ 'shape' => 'FrameworkVersion', ], ], ], 'InputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], 'max' => 20, 'min' => 1, ], 'InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'InputModes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInputMode', ], 'min' => 1, ], 'InstanceGroup' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'InstanceGroupName', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'InstanceGroupName', ], ], ], 'InstanceGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.+', ], 'InstanceGroupNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupName', ], 'max' => 5, ], 'InstanceGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroup', ], 'max' => 5, ], 'InstanceMetadataServiceConfiguration' => [ 'type' => 'structure', 'required' => [ 'MinimumInstanceMetadataServiceVersion', ], 'members' => [ 'MinimumInstanceMetadataServiceVersion' => [ 'shape' => 'MinimumInstanceMetadataServiceVersion', ], ], ], 'InstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'IntegerParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'IntegerParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerParameterRange', ], 'max' => 30, 'min' => 0, ], 'IntegerValue' => [ 'type' => 'integer', ], 'InvocationEndTime' => [ 'type' => 'timestamp', ], 'InvocationStartTime' => [ 'type' => 'timestamp', ], 'InvocationsMaxRetries' => [ 'type' => 'integer', 'max' => 3, 'min' => 0, ], 'InvocationsTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 1, ], 'IotRoleAlias' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'ItemIdentifierAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'JobDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'JobReferenceCode' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.+', ], 'JobReferenceCodeContains' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'JobType' => [ 'type' => 'string', 'enum' => [ 'TRAINING', 'INFERENCE', 'NOTEBOOK_KERNEL', ], ], 'JoinSource' => [ 'type' => 'string', 'enum' => [ 'Input', 'None', ], ], 'JsonContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'JsonContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'JsonContentType', ], 'max' => 10, 'min' => 1, ], 'JsonPath' => [ 'type' => 'string', 'max' => 63, 'min' => 0, ], 'JupyterServerAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'KeepAlivePeriodInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'KernelDisplayName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelGatewayAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'KernelGatewayImageConfig' => [ 'type' => 'structure', 'required' => [ 'KernelSpecs', ], 'members' => [ 'KernelSpecs' => [ 'shape' => 'KernelSpecs', ], 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], ], ], 'KernelName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelSpec' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'KernelName', ], 'DisplayName' => [ 'shape' => 'KernelDisplayName', ], ], ], 'KernelSpecs' => [ 'type' => 'list', 'member' => [ 'shape' => 'KernelSpec', ], 'max' => 1, 'min' => 1, ], 'Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'LabelAttributeName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}', ], 'LabelCounter' => [ 'type' => 'integer', 'min' => 0, ], 'LabelCounters' => [ 'type' => 'structure', 'members' => [ 'TotalLabeled' => [ 'shape' => 'LabelCounter', ], 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'MachineLabeled' => [ 'shape' => 'LabelCounter', ], 'FailedNonRetryableError' => [ 'shape' => 'LabelCounter', ], 'Unlabeled' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelCountersForWorkteam' => [ 'type' => 'structure', 'members' => [ 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'PendingHuman' => [ 'shape' => 'LabelCounter', ], 'Total' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:.*', ], 'LabelingJobAlgorithmsConfig' => [ 'type' => 'structure', 'required' => [ 'LabelingJobAlgorithmSpecificationArn', ], 'members' => [ 'LabelingJobAlgorithmSpecificationArn' => [ 'shape' => 'LabelingJobAlgorithmSpecificationArn', ], 'InitialActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], 'LabelingJobResourceConfig' => [ 'shape' => 'LabelingJobResourceConfig', ], ], ], 'LabelingJobArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/.*', ], 'LabelingJobDataAttributes' => [ 'type' => 'structure', 'members' => [ 'ContentClassifiers' => [ 'shape' => 'ContentClassifiers', ], ], ], 'LabelingJobDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'LabelingJobS3DataSource', ], 'SnsDataSource' => [ 'shape' => 'LabelingJobSnsDataSource', ], ], ], 'LabelingJobForWorkteamSummary' => [ 'type' => 'structure', 'required' => [ 'JobReferenceCode', 'WorkRequesterAccountId', 'CreationTime', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'WorkRequesterAccountId' => [ 'shape' => 'AccountId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LabelCounters' => [ 'shape' => 'LabelCountersForWorkteam', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], ], ], 'LabelingJobForWorkteamSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobForWorkteamSummary', ], ], 'LabelingJobInputConfig' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'LabelingJobDataSource', ], 'DataAttributes' => [ 'shape' => 'LabelingJobDataAttributes', ], ], ], 'LabelingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'LabelingJobOutput' => [ 'type' => 'structure', 'required' => [ 'OutputDatasetS3Uri', ], 'members' => [ 'OutputDatasetS3Uri' => [ 'shape' => 'S3Uri', ], 'FinalActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'LabelingJobOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobResourceConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'LabelingJobS3DataSource' => [ 'type' => 'structure', 'required' => [ 'ManifestS3Uri', ], 'members' => [ 'ManifestS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'LabelingJobSnsDataSource' => [ 'type' => 'structure', 'required' => [ 'SnsTopicArn', ], 'members' => [ 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'LabelingJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxHumanLabeledObjectCount' => [ 'shape' => 'MaxHumanLabeledObjectCount', ], 'MaxPercentageOfInputDatasetLabeled' => [ 'shape' => 'MaxPercentageOfInputDatasetLabeled', ], ], ], 'LabelingJobSummary' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelingJobArn', 'CreationTime', 'LastModifiedTime', 'LabelingJobStatus', 'LabelCounters', 'WorkteamArn', 'PreHumanTaskLambdaArn', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], ], ], 'LabelingJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobSummary', ], ], 'LambdaFunctionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:.*', ], 'LambdaStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'LastModifiedTime' => [ 'type' => 'timestamp', ], 'LastUpdateStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'LastUpdateStatusValue', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'LastUpdateStatusValue' => [ 'type' => 'string', 'enum' => [ 'Successful', 'Failed', 'InProgress', ], ], 'LifecycleConfigArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], 'LineageEntityParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'StringParameterValue', ], 'max' => 30, ], 'LineageGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/.*', ], 'LineageGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'LineageGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageGroupSummary', ], ], 'LineageGroupSummary' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'LineageType' => [ 'type' => 'string', 'enum' => [ 'TrialComponent', 'Artifact', 'Context', 'Action', ], ], 'ListActionsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ActionType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortActionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ActionSummaries' => [ 'shape' => 'ActionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAlgorithmsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'AlgorithmSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAlgorithmsOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSummaryList', ], 'members' => [ 'AlgorithmSummaryList' => [ 'shape' => 'AlgorithmSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageVersionAliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppImageConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'AppImageConfigName', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'AppImageConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAppImageConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'AppImageConfigs' => [ 'shape' => 'AppImageConfigList', ], ], ], 'ListAppsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'AppSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameEquals' => [ 'shape' => 'UserProfileName', ], 'SpaceNameEquals' => [ 'shape' => 'SpaceName', ], ], ], 'ListAppsResponse' => [ 'type' => 'structure', 'members' => [ 'Apps' => [ 'shape' => 'AppList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListArtifactsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortArtifactsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListArtifactsResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactSummaries' => [ 'shape' => 'ArtifactSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortAssociationsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationSummaries' => [ 'shape' => 'AssociationSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'AutoMLNameContains', ], 'StatusEquals' => [ 'shape' => 'AutoMLJobStatus', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'AutoMLSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobSummaries', ], 'members' => [ 'AutoMLJobSummaries' => [ 'shape' => 'AutoMLJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'StatusEquals' => [ 'shape' => 'CandidateStatus', ], 'CandidateNameEquals' => [ 'shape' => 'CandidateName', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'CandidateSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'Candidates', ], 'members' => [ 'Candidates' => [ 'shape' => 'AutoMLCandidates', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCodeRepositoriesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'CodeRepositoryNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'CodeRepositorySortBy', ], 'SortOrder' => [ 'shape' => 'CodeRepositorySortOrder', ], ], ], 'ListCodeRepositoriesOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositorySummaryList', ], 'members' => [ 'CodeRepositorySummaryList' => [ 'shape' => 'CodeRepositorySummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'CompilationJobStatus', ], 'SortBy' => [ 'shape' => 'ListCompilationJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListCompilationJobsResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobSummaries', ], 'members' => [ 'CompilationJobSummaries' => [ 'shape' => 'CompilationJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListContextsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortContextsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListContextsResponse' => [ 'type' => 'structure', 'members' => [ 'ContextSummaries' => [ 'shape' => 'ContextSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListDataQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListDeviceFleetsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListDeviceFleetsResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetSummaries', ], 'members' => [ 'DeviceFleetSummaries' => [ 'shape' => 'DeviceFleetSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListDevicesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'LatestHeartbeatAfter' => [ 'shape' => 'Timestamp', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'ListDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceSummaries', ], 'members' => [ 'DeviceSummaries' => [ 'shape' => 'DeviceSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Domains' => [ 'shape' => 'DomainList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'DeviceFleetNameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListEdgeDeploymentPlansSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgeDeploymentPlansResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanSummaries', ], 'members' => [ 'EdgeDeploymentPlanSummaries' => [ 'shape' => 'EdgeDeploymentPlanSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'DEVICE_FLEET_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListEdgePackagingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelNameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'EdgePackagingJobStatus', ], 'SortBy' => [ 'shape' => 'ListEdgePackagingJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgePackagingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobSummaries', ], 'members' => [ 'EdgePackagingJobSummaries' => [ 'shape' => 'EdgePackagingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgePackagingJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'MODEL_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'STATUS', ], ], 'ListEndpointConfigsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointConfigSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListEndpointConfigsOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigs', ], 'members' => [ 'EndpointConfigs' => [ 'shape' => 'EndpointConfigSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListEndpointsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'EndpointStatus', ], ], ], 'ListEndpointsOutput' => [ 'type' => 'structure', 'required' => [ 'Endpoints', ], 'members' => [ 'Endpoints' => [ 'shape' => 'EndpointSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentSummaries' => [ 'shape' => 'ExperimentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'FeatureGroupNameContains', ], 'FeatureGroupStatusEquals' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatusEquals' => [ 'shape' => 'OfflineStoreStatusValue', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'SortOrder' => [ 'shape' => 'FeatureGroupSortOrder', ], 'SortBy' => [ 'shape' => 'FeatureGroupSortBy', ], 'MaxResults' => [ 'shape' => 'FeatureGroupMaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupSummaries', 'NextToken', ], 'members' => [ 'FeatureGroupSummaries' => [ 'shape' => 'FeatureGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFlowDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListFlowDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionSummaries', ], 'members' => [ 'FlowDefinitionSummaries' => [ 'shape' => 'FlowDefinitionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'MinVersion' => [ 'shape' => 'HubContentVersion', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsResponse' => [ 'type' => 'structure', 'required' => [ 'HubSummaries', ], 'members' => [ 'HubSummaries' => [ 'shape' => 'HubInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHumanTaskUisRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListHumanTaskUisResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiSummaries', ], 'members' => [ 'HumanTaskUiSummaries' => [ 'shape' => 'HumanTaskUiSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHyperParameterTuningJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'SortBy' => [ 'shape' => 'HyperParameterTuningJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'HyperParameterTuningJobStatus', ], ], ], 'ListHyperParameterTuningJobsResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobSummaries', ], 'members' => [ 'HyperParameterTuningJobSummaries' => [ 'shape' => 'HyperParameterTuningJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ImageVersionSortOrder', ], ], ], 'ListImageVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersions' => [ 'shape' => 'ImageVersions', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImagesRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ImageNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageSortBy', ], 'SortOrder' => [ 'shape' => 'ImageSortOrder', ], ], ], 'ListImagesResponse' => [ 'type' => 'structure', 'members' => [ 'Images' => [ 'shape' => 'Images', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'StatusEquals' => [ 'shape' => 'InferenceExperimentStatus', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortInferenceExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListInferenceExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceExperiments' => [ 'shape' => 'InferenceExperimentList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'InferenceRecommendationsJobSteps', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'RecommendationJobStatus', ], 'SortBy' => [ 'shape' => 'ListInferenceRecommendationsJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelNameEquals' => [ 'shape' => 'ModelName', ], 'ModelPackageVersionArnEquals' => [ 'shape' => 'ModelPackageArn', ], ], ], 'ListInferenceRecommendationsJobsResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobs', ], 'members' => [ 'InferenceRecommendationsJobs' => [ 'shape' => 'InferenceRecommendationsJobs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'JobReferenceCodeContains' => [ 'shape' => 'JobReferenceCodeContains', ], 'SortBy' => [ 'shape' => 'ListLabelingJobsForWorkteamSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListLabelingJobsForWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobSummaryList', ], 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobForWorkteamSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ListLabelingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'StatusEquals' => [ 'shape' => 'LabelingJobStatus', ], ], ], 'ListLabelingJobsResponse' => [ 'type' => 'structure', 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLineageEntityParameterKey' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringParameterValue', ], ], 'ListLineageGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortLineageGroupsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListLineageGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupSummaries' => [ 'shape' => 'LineageGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'ListModelBiasJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelBiasJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModelCardExportJobNameContains' => [ 'shape' => 'EntityName', ], 'StatusEquals' => [ 'shape' => 'ModelCardExportJobStatus', ], 'SortBy' => [ 'shape' => 'ModelCardExportJobSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardExportJobSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelCardExportJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobSummaries', ], 'members' => [ 'ModelCardExportJobSummaries' => [ 'shape' => 'ModelCardExportJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardVersionSummaryList', ], 'members' => [ 'ModelCardVersionSummaryList' => [ 'shape' => 'ModelCardVersionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EntityName', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardSummaries', ], 'members' => [ 'ModelCardSummaries' => [ 'shape' => 'ModelCardSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelMetadataRequest' => [ 'type' => 'structure', 'members' => [ 'SearchExpression' => [ 'shape' => 'ModelMetadataSearchExpression', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'ModelMetadataSummaries', ], 'members' => [ 'ModelMetadataSummaries' => [ 'shape' => 'ModelMetadataSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackageGroupsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageGroupSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackageGroupsOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupSummaryList', ], 'members' => [ 'ModelPackageGroupSummaryList' => [ 'shape' => 'ModelPackageGroupSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackagesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageType' => [ 'shape' => 'ModelPackageType', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackagesOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageSummaryList', ], 'members' => [ 'ModelPackageSummaryList' => [ 'shape' => 'ModelPackageSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ModelSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ModelNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelsOutput' => [ 'type' => 'structure', 'required' => [ 'Models', ], 'members' => [ 'Models' => [ 'shape' => 'ModelSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListMonitoringAlertHistoryRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'SortBy' => [ 'shape' => 'MonitoringAlertHistorySortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'ListMonitoringAlertHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertHistory' => [ 'shape' => 'MonitoringAlertHistoryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringAlertsRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMonitoringAlertsResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringExecutionsRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringExecutionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ScheduledTimeBefore' => [ 'shape' => 'Timestamp', ], 'ScheduledTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ExecutionStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringExecutionsResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringExecutionSummaries', ], 'members' => [ 'MonitoringExecutionSummaries' => [ 'shape' => 'MonitoringExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringSchedulesRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringScheduleSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringSchedulesResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleSummaries', ], 'members' => [ 'MonitoringScheduleSummaries' => [ 'shape' => 'MonitoringScheduleSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], ], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstanceLifecycleConfigs' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummaryList', ], ], ], 'ListNotebookInstancesInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'StatusEquals' => [ 'shape' => 'NotebookInstanceStatus', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepositoryContains' => [ 'shape' => 'CodeRepositoryContains', ], 'AdditionalCodeRepositoryEquals' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], ], ], 'ListNotebookInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstances' => [ 'shape' => 'NotebookInstanceSummaryList', ], ], ], 'ListPipelineExecutionStepsRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListPipelineExecutionStepsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSteps' => [ 'shape' => 'PipelineExecutionStepList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineExecutionsRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelineExecutionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineExecutionsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSummaries' => [ 'shape' => 'PipelineExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineParametersForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineParametersForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelinesRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineNamePrefix' => [ 'shape' => 'PipelineName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelinesBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelinesResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineSummaries' => [ 'shape' => 'PipelineSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProcessingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'String', ], 'StatusEquals' => [ 'shape' => 'ProcessingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListProcessingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobSummaries', ], 'members' => [ 'ProcessingJobSummaries' => [ 'shape' => 'ProcessingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProjectsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ProjectEntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ProjectSortBy', ], 'SortOrder' => [ 'shape' => 'ProjectSortOrder', ], ], ], 'ListProjectsOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectSummaryList', ], 'members' => [ 'ProjectSummaryList' => [ 'shape' => 'ProjectSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'ResourceCatalogName', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'ResourceCatalogSortOrder', ], 'SortBy' => [ 'shape' => 'ResourceCatalogSortBy', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceCatalogs' => [ 'shape' => 'ResourceCatalogList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSpacesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'SpaceSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'SpaceNameContains' => [ 'shape' => 'SpaceName', ], ], ], 'ListSpacesResponse' => [ 'type' => 'structure', 'members' => [ 'Spaces' => [ 'shape' => 'SpaceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStageDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ExcludeDevicesDeployedInOtherStage' => [ 'shape' => 'Boolean', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'ListStageDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceDeploymentSummaries', ], 'members' => [ 'DeviceDeploymentSummaries' => [ 'shape' => 'DeviceDeploymentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStudioLifecycleConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'StudioLifecycleConfigName', ], 'AppTypeEquals' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'StudioLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListStudioLifecycleConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'StudioLifecycleConfigs' => [ 'shape' => 'StudioLifecycleConfigsList', ], ], ], 'ListSubscribedWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListSubscribedWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteams', ], 'members' => [ 'SubscribedWorkteams' => [ 'shape' => 'SubscribedWorkteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListTagsMaxResults', ], ], ], 'ListTagsMaxResults' => [ 'type' => 'integer', 'min' => 50, ], 'ListTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'TrainingJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'HyperParameterTrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'WarmPoolStatusEquals' => [ 'shape' => 'WarmPoolResourceStatus', ], ], ], 'ListTrainingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'TrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTransformJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TransformJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListTransformJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobSummaries', ], 'members' => [ 'TransformJobSummaries' => [ 'shape' => 'TransformJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentKey256' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentKey256', ], ], 'ListTrialComponentsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'SourceArn' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialComponentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialSummaries' => [ 'shape' => 'TrialSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'UserProfileSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameContains' => [ 'shape' => 'UserProfileName', ], ], ], 'ListUserProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfiles' => [ 'shape' => 'UserProfileList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkforcesSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkforceName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkforcesResponse' => [ 'type' => 'structure', 'required' => [ 'Workforces', ], 'members' => [ 'Workforces' => [ 'shape' => 'Workforces', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'ListWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkteamsSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'Workteams', ], 'members' => [ 'Workteams' => [ 'shape' => 'Workteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkteamsSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'Long' => [ 'type' => 'long', ], 'MLFramework' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxCandidates' => [ 'type' => 'integer', 'max' => 750, 'min' => 1, ], 'MaxConcurrentInvocationsPerInstance' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'MaxConcurrentTaskCount' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'MaxConcurrentTransforms' => [ 'type' => 'integer', 'min' => 0, ], 'MaxHumanLabeledObjectCount' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'type' => 'integer', 'min' => 3, ], 'MaxParallelExecutionSteps' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxPayloadInMB' => [ 'type' => 'integer', 'min' => 0, ], 'MaxPercentageOfInputDatasetLabeled' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxWaitTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaximumExecutionTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 28800, 'min' => 600, ], 'MaximumRetryAttempts' => [ 'type' => 'integer', 'max' => 30, 'min' => 1, ], 'MediaType' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[-\\w]+\\/[-\\w+]+$', ], 'MemberDefinition' => [ 'type' => 'structure', 'members' => [ 'CognitoMemberDefinition' => [ 'shape' => 'CognitoMemberDefinition', ], 'OidcMemberDefinition' => [ 'shape' => 'OidcMemberDefinition', ], ], ], 'MemberDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberDefinition', ], 'max' => 10, 'min' => 1, ], 'MetadataProperties' => [ 'type' => 'structure', 'members' => [ 'CommitId' => [ 'shape' => 'MetadataPropertyValue', ], 'Repository' => [ 'shape' => 'MetadataPropertyValue', ], 'GeneratedBy' => [ 'shape' => 'MetadataPropertyValue', ], 'ProjectId' => [ 'shape' => 'MetadataPropertyValue', ], ], ], 'MetadataPropertyValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'MetricData' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'Float', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'MetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatum', ], 'max' => 40, 'min' => 0, ], 'MetricDatum' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'Float', ], 'Set' => [ 'shape' => 'MetricSetSource', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricExtendedEnum', ], ], ], 'MetricDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Regex', ], 'members' => [ 'Name' => [ 'shape' => 'MetricName', ], 'Regex' => [ 'shape' => 'MetricRegex', ], ], ], 'MetricDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDefinition', ], 'max' => 40, 'min' => 0, ], 'MetricName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'MetricRegex' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.+', ], 'MetricSetSource' => [ 'type' => 'string', 'enum' => [ 'Train', 'Validation', 'Test', ], ], 'MetricValue' => [ 'type' => 'float', ], 'MetricsSource' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'type' => 'string', 'max' => 1, 'pattern' => '1|2', ], 'Model' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'ModelApprovalStatus' => [ 'type' => 'string', 'enum' => [ 'Approved', 'Rejected', 'PendingManualApproval', ], ], 'ModelArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model/.*', ], 'ModelArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ModelArtifacts', ], 'members' => [ 'S3ModelArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelBiasAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelBiasBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelBiasJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelCacheSetting' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], 'ModelPackageGroupName' => [ 'shape' => 'String', ], ], ], 'ModelCardArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardContent' => [ 'type' => 'string', 'max' => 100000, 'min' => 0, 'pattern' => '.*', 'sensitive' => true, ], 'ModelCardExportArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ExportArtifacts', ], 'members' => [ 'S3ExportArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardExportJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardExportJobSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ModelCardExportJobSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', ], ], 'ModelCardExportJobSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardExportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardExportJobSummary', ], ], 'ModelCardExportOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardProcessingStatus' => [ 'type' => 'string', 'enum' => [ 'DeleteInProgress', 'DeletePending', 'ContentDeleted', 'ExportJobsDeleted', 'DeleteCompleted', 'DeleteFailed', ], ], 'ModelCardSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ModelCardSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelCardSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardStatus' => [ 'type' => 'string', 'enum' => [ 'Draft', 'PendingReview', 'Approved', 'Archived', ], ], 'ModelCardSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardSummary', ], ], 'ModelCardVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'Version', ], ], 'ModelCardVersionSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'ModelCardVersion', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardVersionSummary', ], ], 'ModelClientConfig' => [ 'type' => 'structure', 'members' => [ 'InvocationsTimeoutInSeconds' => [ 'shape' => 'InvocationsTimeoutInSeconds', ], 'InvocationsMaxRetries' => [ 'shape' => 'InvocationsMaxRetries', ], ], ], 'ModelCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ModelConfiguration' => [ 'type' => 'structure', 'members' => [ 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameters' => [ 'shape' => 'EnvironmentParameters', ], 'CompilationJobName' => [ 'shape' => 'RecommendationJobCompilationJobName', ], ], ], 'ModelDashboardEndpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'ModelDashboardEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardEndpoint', ], ], 'ModelDashboardIndicatorAction' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'ModelDashboardModel' => [ 'type' => 'structure', 'members' => [ 'Model' => [ 'shape' => 'Model', ], 'Endpoints' => [ 'shape' => 'ModelDashboardEndpoints', ], 'LastBatchTransformJob' => [ 'shape' => 'TransformJob', ], 'MonitoringSchedules' => [ 'shape' => 'ModelDashboardMonitoringSchedules', ], 'ModelCard' => [ 'shape' => 'ModelDashboardModelCard', ], ], ], 'ModelDashboardModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], ], ], 'ModelDashboardMonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], ], ], 'ModelDashboardMonitoringSchedules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardMonitoringSchedule', ], ], 'ModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'S3ModelDataSource', ], ], ], 'ModelDeployConfig' => [ 'type' => 'structure', 'members' => [ 'AutoGenerateEndpointName' => [ 'shape' => 'AutoGenerateEndpointName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDeployResult' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDigests' => [ 'type' => 'structure', 'members' => [ 'ArtifactDigest' => [ 'shape' => 'ArtifactDigest', ], ], ], 'ModelExplainabilityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelExplainabilityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelExplainabilityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelInfrastructureConfig' => [ 'type' => 'structure', 'required' => [ 'InfrastructureType', 'RealTimeInferenceConfig', ], 'members' => [ 'InfrastructureType' => [ 'shape' => 'ModelInfrastructureType', ], 'RealTimeInferenceConfig' => [ 'shape' => 'RealTimeInferenceConfig', ], ], ], 'ModelInfrastructureType' => [ 'type' => 'string', 'enum' => [ 'RealTimeInference', ], ], 'ModelInput' => [ 'type' => 'structure', 'required' => [ 'DataInputConfig', ], 'members' => [ 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'ModelInsightsLocation' => [ 'type' => 'string', 'min' => 1, ], 'ModelLatencyThreshold' => [ 'type' => 'structure', 'members' => [ 'Percentile' => [ 'shape' => 'String64', ], 'ValueInMilliseconds' => [ 'shape' => 'Integer', ], ], ], 'ModelLatencyThresholds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelLatencyThreshold', ], 'max' => 1, 'min' => 1, ], 'ModelMetadataFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'ModelMetadataFilterType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ModelMetadataFilterType' => [ 'type' => 'string', 'enum' => [ 'Domain', 'Framework', 'Task', 'FrameworkVersion', ], ], 'ModelMetadataFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataFilter', ], 'max' => 4, 'min' => 1, ], 'ModelMetadataSearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ModelMetadataFilters', ], ], ], 'ModelMetadataSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataSummary', ], ], 'ModelMetadataSummary' => [ 'type' => 'structure', 'required' => [ 'Domain', 'Framework', 'Task', 'Model', 'FrameworkVersion', ], 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Model' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'String', ], ], ], 'ModelMetrics' => [ 'type' => 'structure', 'members' => [ 'ModelQuality' => [ 'shape' => 'ModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'ModelDataQuality', ], 'Bias' => [ 'shape' => 'Bias', ], 'Explainability' => [ 'shape' => 'Explainability', ], ], ], 'ModelName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'ModelNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'ModelPackage' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], ], ], 'ModelPackageArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-package/.*', ], 'ModelPackageArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageArn', ], 'max' => 100, 'min' => 1, ], 'ModelPackageContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', ], 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageDigest' => [ 'shape' => 'ImageDigest', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelInput' => [ 'shape' => 'ModelInput', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'ModelPackageFrameworkVersion', ], 'NearestModelName' => [ 'shape' => 'String', ], ], ], 'ModelPackageContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageContainerDefinition', ], 'max' => 15, 'min' => 1, ], 'ModelPackageFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'ModelPackageGroup' => [ 'type' => 'structure', 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ModelPackageGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-package-group/.*', ], 'ModelPackageGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', 'DeleteFailed', ], ], 'ModelPackageGroupSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'ModelPackageGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageGroupSummary', ], ], 'ModelPackageSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'ModelPackageStatusDetails' => [ 'type' => 'structure', 'required' => [ 'ValidationStatuses', ], 'members' => [ 'ValidationStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], ], ], 'ModelPackageStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedModelPackageStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'ModelPackageStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageStatusItem', ], ], 'ModelPackageSummaries' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageSummary', ], ], 'ModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'ModelPackageSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageSummary', ], ], 'ModelPackageType' => [ 'type' => 'string', 'enum' => [ 'Versioned', 'Unversioned', 'Both', ], ], 'ModelPackageValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TransformJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'ModelPackageValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageValidationProfile', ], 'max' => 1, 'min' => 1, ], 'ModelPackageValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'ModelPackageValidationProfiles', ], ], ], 'ModelPackageVersion' => [ 'type' => 'integer', 'min' => 1, ], 'ModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'ProblemType' => [ 'shape' => 'MonitoringProblemType', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelQualityJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelRegisterSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'CrossAccountModelRegisterRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'ModelSetupTime' => [ 'type' => 'integer', 'min' => 0, ], 'ModelSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelArn', 'CreationTime', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelSummary', ], ], 'ModelVariantAction' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Remove', 'Promote', ], ], 'ModelVariantActionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelVariantName', ], 'value' => [ 'shape' => 'ModelVariantAction', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], ], ], 'ModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfig', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfigSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', 'Status', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], 'Status' => [ 'shape' => 'ModelVariantStatus', ], ], ], 'ModelVariantConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfigSummary', ], ], 'ModelVariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelVariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'InService', 'Deleting', 'Deleted', ], ], 'MonitoringAlertActions' => [ 'type' => 'structure', 'members' => [ 'ModelDashboardIndicator' => [ 'shape' => 'ModelDashboardIndicatorAction', ], ], ], 'MonitoringAlertHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertHistorySummary', ], ], 'MonitoringAlertHistorySortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', ], ], 'MonitoringAlertHistorySummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'CreationTime', 'AlertStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'MonitoringAlertName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringAlertStatus' => [ 'type' => 'string', 'enum' => [ 'InAlert', 'OK', ], ], 'MonitoringAlertSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringAlertName', 'CreationTime', 'LastModifiedTime', 'AlertStatus', 'DatapointsToAlert', 'EvaluationPeriod', 'Actions', ], 'members' => [ 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], 'Actions' => [ 'shape' => 'MonitoringAlertActions', ], ], ], 'MonitoringAlertSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertSummary', ], 'max' => 100, 'min' => 1, ], 'MonitoringAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'MonitoringClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringConstraintsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 50, 'min' => 1, ], 'MonitoringCsvDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Header' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringDatapointsToAlert' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Csv' => [ 'shape' => 'MonitoringCsvDatasetFormat', ], 'Json' => [ 'shape' => 'MonitoringJsonDatasetFormat', ], 'Parquet' => [ 'shape' => 'MonitoringParquetDatasetFormat', ], ], ], 'MonitoringEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 50, ], 'MonitoringEvaluationPeriod' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringExecutionSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'ScheduledTime', 'Status', ], ], 'MonitoringExecutionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'ScheduledTime', 'CreationTime', 'LastModifiedTime', 'MonitoringExecutionStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringExecutionStatus' => [ 'shape' => 'ExecutionStatus', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringExecutionSummary', ], ], 'MonitoringGroundTruthS3Input' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], ], ], 'MonitoringInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'MonitoringInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringInput', ], 'max' => 1, 'min' => 1, ], 'MonitoringJobDefinition' => [ 'type' => 'structure', 'required' => [ 'MonitoringInputs', 'MonitoringOutputConfig', 'MonitoringResources', 'MonitoringAppSpecification', 'RoleArn', ], 'members' => [ 'BaselineConfig' => [ 'shape' => 'MonitoringBaselineConfig', ], 'MonitoringInputs' => [ 'shape' => 'MonitoringInputs', ], 'MonitoringOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'MonitoringResources' => [ 'shape' => 'MonitoringResources', ], 'MonitoringAppSpecification' => [ 'shape' => 'MonitoringAppSpecification', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'MonitoringJobDefinitionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringJobDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'MonitoringJobDefinitionSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'MonitoringJobDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringJobDefinitionName', 'MonitoringJobDefinitionArn', 'CreationTime', 'EndpointName', ], 'members' => [ 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringJobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'MonitoringJobDefinitionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringJobDefinitionSummary', ], ], 'MonitoringJsonDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Line' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'MonitoringNetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'MonitoringOutput' => [ 'type' => 'structure', 'required' => [ 'S3Output', ], 'members' => [ 'S3Output' => [ 'shape' => 'MonitoringS3Output', ], ], ], 'MonitoringOutputConfig' => [ 'type' => 'structure', 'required' => [ 'MonitoringOutputs', ], 'members' => [ 'MonitoringOutputs' => [ 'shape' => 'MonitoringOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringOutput', ], 'max' => 1, 'min' => 1, ], 'MonitoringParquetDatasetFormat' => [ 'type' => 'structure', 'members' => [], ], 'MonitoringProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'MonitoringResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'MonitoringClusterConfig', ], ], ], 'MonitoringS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', ], 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'MonitoringS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'MonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'MonitoringScheduleArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringScheduleConfig' => [ 'type' => 'structure', 'members' => [ 'ScheduleConfig' => [ 'shape' => 'ScheduleConfig', ], 'MonitoringJobDefinition' => [ 'shape' => 'MonitoringJobDefinition', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringSchedule', ], ], 'MonitoringScheduleName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringScheduleSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'MonitoringScheduleSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleArn', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringScheduleSummary', ], ], 'MonitoringStatisticsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MonitoringMaxRuntimeInSeconds', ], ], ], 'MonitoringTimeOffsetString' => [ 'type' => 'string', 'max' => 15, 'min' => 1, 'pattern' => '^.?P.*', ], 'MonitoringType' => [ 'type' => 'string', 'enum' => [ 'DataQuality', 'ModelQuality', 'ModelBias', 'ModelExplainability', ], ], 'MountPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^\\/.*', ], 'MultiModelConfig' => [ 'type' => 'structure', 'members' => [ 'ModelCacheSetting' => [ 'shape' => 'ModelCacheSetting', ], ], ], 'NameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'NeoVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'NeoVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'NeoVpcSubnets', ], ], ], 'NeoVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'NeoVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'NestedFilters' => [ 'type' => 'structure', 'required' => [ 'NestedPropertyName', 'Filters', ], 'members' => [ 'NestedPropertyName' => [ 'shape' => 'ResourcePropertyName', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'NestedFiltersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NestedFilters', ], 'max' => 20, 'min' => 1, ], 'NetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'NetworkInterfaceId' => [ 'type' => 'string', ], 'NextToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'NotebookInstanceAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'NotebookInstanceAcceleratorTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceAcceleratorType', ], ], 'NotebookInstanceArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'NotebookInstanceLifecycleConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleHook', ], 'max' => 1, ], 'NotebookInstanceLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', 'NotebookInstanceLifecycleConfigArn', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummary', ], ], 'NotebookInstanceLifecycleHook' => [ 'type' => 'structure', 'members' => [ 'Content' => [ 'shape' => 'NotebookInstanceLifecycleConfigContent', ], ], ], 'NotebookInstanceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'NotebookInstanceSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InService', 'Stopping', 'Stopped', 'Failed', 'Deleting', 'Updating', ], ], 'NotebookInstanceSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'NotebookInstanceArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], ], ], 'NotebookInstanceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceSummary', ], ], 'NotebookInstanceUrl' => [ 'type' => 'string', ], 'NotebookInstanceVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'NotebookOutputOption' => [ 'type' => 'string', 'enum' => [ 'Allowed', 'Disabled', ], ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'NotificationTopicArn' => [ 'shape' => 'NotificationTopicArn', ], ], ], 'NotificationTopicArn' => [ 'type' => 'string', 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*', ], 'NumberOfHumanWorkersPerDataObject' => [ 'type' => 'integer', 'max' => 9, 'min' => 1, ], 'NumberOfSteps' => [ 'type' => 'integer', 'min' => 1, ], 'ObjectiveStatus' => [ 'type' => 'string', 'enum' => [ 'Succeeded', 'Pending', 'Failed', ], ], 'ObjectiveStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'ObjectiveStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Succeeded' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Pending' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Failed' => [ 'shape' => 'ObjectiveStatusCounter', ], ], ], 'OfflineStoreConfig' => [ 'type' => 'structure', 'required' => [ 'S3StorageConfig', ], 'members' => [ 'S3StorageConfig' => [ 'shape' => 'S3StorageConfig', ], 'DisableGlueTableCreation' => [ 'shape' => 'Boolean', ], 'DataCatalogConfig' => [ 'shape' => 'DataCatalogConfig', ], 'TableFormat' => [ 'shape' => 'TableFormat', ], ], ], 'OfflineStoreStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'OfflineStoreStatusValue', ], 'BlockedReason' => [ 'shape' => 'BlockedReason', ], ], ], 'OfflineStoreStatusValue' => [ 'type' => 'string', 'enum' => [ 'Active', 'Blocked', 'Disabled', ], ], 'OidcConfig' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'ClientSecret', 'Issuer', 'AuthorizationEndpoint', 'TokenEndpoint', 'UserInfoEndpoint', 'LogoutEndpoint', 'JwksUri', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'ClientSecret' => [ 'shape' => 'ClientSecret', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcConfigForResponse' => [ 'type' => 'structure', 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcEndpoint' => [ 'type' => 'string', 'max' => 500, 'pattern' => 'https://\\S+', ], 'OidcMemberDefinition' => [ 'type' => 'structure', 'required' => [ 'Groups', ], 'members' => [ 'Groups' => [ 'shape' => 'Groups', ], ], ], 'OnlineStoreConfig' => [ 'type' => 'structure', 'members' => [ 'SecurityConfig' => [ 'shape' => 'OnlineStoreSecurityConfig', ], 'EnableOnlineStore' => [ 'shape' => 'Boolean', ], 'TtlDuration' => [ 'shape' => 'TtlDuration', ], ], ], 'OnlineStoreConfigUpdate' => [ 'type' => 'structure', 'members' => [ 'TtlDuration' => [ 'shape' => 'TtlDuration', ], ], ], 'OnlineStoreSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OnlineStoreTotalSizeBytes' => [ 'type' => 'long', ], 'Operator' => [ 'type' => 'string', 'enum' => [ 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqualTo', 'LessThan', 'LessThanOrEqualTo', 'Contains', 'Exists', 'NotExists', 'In', ], ], 'OptionalDouble' => [ 'type' => 'double', ], 'OptionalInteger' => [ 'type' => 'integer', ], 'OptionalVolumeSizeInGB' => [ 'type' => 'integer', 'min' => 0, ], 'OrderKey' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'OutputCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'NONE', ], ], 'OutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'TargetDevice' => [ 'shape' => 'TargetDevice', ], 'TargetPlatform' => [ 'shape' => 'TargetPlatform', ], 'CompilerOptions' => [ 'shape' => 'CompilerOptions', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'OutputCompressionType', ], ], ], 'OutputParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String256', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'OutputParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputParameter', ], 'max' => 50, 'min' => 0, ], 'PaginationToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'ParallelismConfiguration' => [ 'type' => 'structure', 'required' => [ 'MaxParallelExecutionSteps', ], 'members' => [ 'MaxParallelExecutionSteps' => [ 'shape' => 'MaxParallelExecutionSteps', ], ], ], 'Parameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'PipelineParameterName', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'ParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], 'max' => 50, 'min' => 0, ], 'ParameterName' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'ParameterRange' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRangeSpecification' => [ 'shape' => 'IntegerParameterRangeSpecification', ], 'ContinuousParameterRangeSpecification' => [ 'shape' => 'ContinuousParameterRangeSpecification', ], 'CategoricalParameterRangeSpecification' => [ 'shape' => 'CategoricalParameterRangeSpecification', ], ], ], 'ParameterRanges' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRanges' => [ 'shape' => 'IntegerParameterRanges', ], 'ContinuousParameterRanges' => [ 'shape' => 'ContinuousParameterRanges', ], 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameterRanges', ], 'AutoParameters' => [ 'shape' => 'AutoParameters', ], ], ], 'ParameterType' => [ 'type' => 'string', 'enum' => [ 'Integer', 'Continuous', 'Categorical', 'FreeText', ], ], 'ParameterValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterValue', ], 'max' => 30, 'min' => 1, ], 'Parent' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ParentHyperParameterTuningJob' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'ParentHyperParameterTuningJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParentHyperParameterTuningJob', ], 'max' => 5, 'min' => 1, ], 'Parents' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parent', ], ], 'PendingDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'ShadowProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], ], ], 'PendingProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'PendingProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingProductionVariantSummary', ], 'min' => 1, ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, ], 'Phase' => [ 'type' => 'structure', 'members' => [ 'InitialNumberOfUsers' => [ 'shape' => 'InitialNumberOfUsers', ], 'SpawnRate' => [ 'shape' => 'SpawnRate', ], 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], ], ], 'Phases' => [ 'type' => 'list', 'member' => [ 'shape' => 'Phase', ], 'min' => 1, ], 'Pipeline' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*', ], 'PipelineDefinition' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'PipelineDefinitionS3Location' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ObjectKey', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'ObjectKey' => [ 'shape' => 'Key', ], 'VersionId' => [ 'shape' => 'VersionId', ], ], ], 'PipelineDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecution' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'PipelineExecutionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$', ], 'PipelineExecutionDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecutionFailureReason' => [ 'type' => 'string', 'max' => 1300, 'pattern' => '.*', ], 'PipelineExecutionName' => [ 'type' => 'string', 'max' => 82, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}', ], 'PipelineExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'PipelineExecutionStep' => [ 'type' => 'structure', 'members' => [ 'StepName' => [ 'shape' => 'StepName', ], 'StepDisplayName' => [ 'shape' => 'StepDisplayName', ], 'StepDescription' => [ 'shape' => 'StepDescription', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StepStatus' => [ 'shape' => 'StepStatus', ], 'CacheHitResult' => [ 'shape' => 'CacheHitResult', ], 'AttemptCount' => [ 'shape' => 'IntegerValue', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Metadata' => [ 'shape' => 'PipelineExecutionStepMetadata', ], 'SelectiveExecutionResult' => [ 'shape' => 'SelectiveExecutionResult', ], ], ], 'PipelineExecutionStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionStep', ], 'max' => 100, 'min' => 0, ], 'PipelineExecutionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJobStepMetadata', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJobStepMetadata', ], 'TransformJob' => [ 'shape' => 'TransformJobStepMetadata', ], 'TuningJob' => [ 'shape' => 'TuningJobStepMetaData', ], 'Model' => [ 'shape' => 'ModelStepMetadata', ], 'RegisterModel' => [ 'shape' => 'RegisterModelStepMetadata', ], 'Condition' => [ 'shape' => 'ConditionStepMetadata', ], 'Callback' => [ 'shape' => 'CallbackStepMetadata', ], 'Lambda' => [ 'shape' => 'LambdaStepMetadata', ], 'QualityCheck' => [ 'shape' => 'QualityCheckStepMetadata', ], 'ClarifyCheck' => [ 'shape' => 'ClarifyCheckStepMetadata', ], 'EMR' => [ 'shape' => 'EMRStepMetadata', ], 'Fail' => [ 'shape' => 'FailStepMetadata', ], 'AutoMLJob' => [ 'shape' => 'AutoMLJobStepMetadata', ], ], ], 'PipelineExecutionSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionFailureReason' => [ 'shape' => 'String3072', ], ], ], 'PipelineExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionSummary', ], 'max' => 100, 'min' => 0, ], 'PipelineExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'PipelineName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}', ], 'PipelineNameOrArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})', ], 'PipelineParameterName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$', ], 'PipelineStatus' => [ 'type' => 'string', 'enum' => [ 'Active', ], ], 'PipelineSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastExecutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'PipelineSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineSummary', ], 'max' => 100, 'min' => 0, ], 'PlatformIdentifier' => [ 'type' => 'string', 'max' => 15, 'pattern' => '^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2)$', ], 'PolicyString' => [ 'type' => 'string', 'max' => 20480, 'min' => 1, 'pattern' => '.*', ], 'PresignedDomainUrl' => [ 'type' => 'string', ], 'ProbabilityThresholdAttribute' => [ 'type' => 'double', ], 'ProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'ProcessingClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingEnvironmentKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'ProcessingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 100, ], 'ProcessingEnvironmentValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\S\\s]*', ], 'ProcessingFeatureStoreOutput' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'ProcessingInput' => [ 'type' => 'structure', 'required' => [ 'InputName', ], 'members' => [ 'InputName' => [ 'shape' => 'String', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], 'S3Input' => [ 'shape' => 'ProcessingS3Input', ], 'DatasetDefinition' => [ 'shape' => 'DatasetDefinition', ], ], ], 'ProcessingInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingInput', ], 'max' => 10, 'min' => 0, ], 'ProcessingInstanceCount' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ProcessingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'ProcessingJob' => [ 'type' => 'structure', 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ProcessingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/.*', ], 'ProcessingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ProcessingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ProcessingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'ProcessingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingJobSummary', ], ], 'ProcessingJobSummary' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingJobArn', 'CreationTime', 'ProcessingJobStatus', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], ], ], 'ProcessingLocalPath' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ProcessingMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 604800, 'min' => 1, ], 'ProcessingOutput' => [ 'type' => 'structure', 'required' => [ 'OutputName', ], 'members' => [ 'OutputName' => [ 'shape' => 'String', ], 'S3Output' => [ 'shape' => 'ProcessingS3Output', ], 'FeatureStoreOutput' => [ 'shape' => 'ProcessingFeatureStoreOutput', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], ], ], 'ProcessingOutputConfig' => [ 'type' => 'structure', 'required' => [ 'Outputs', ], 'members' => [ 'Outputs' => [ 'shape' => 'ProcessingOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingOutput', ], 'max' => 10, 'min' => 0, ], 'ProcessingResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'ProcessingClusterConfig', ], ], ], 'ProcessingS3CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ProcessingS3DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'ProcessingS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', ], ], 'ProcessingS3Input' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3DataType' => [ 'shape' => 'ProcessingS3DataType', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'S3CompressionType' => [ 'shape' => 'ProcessingS3CompressionType', ], ], ], 'ProcessingS3InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'ProcessingS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', 'S3UploadMode', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'ProcessingS3UploadMode' => [ 'type' => 'string', 'enum' => [ 'Continuous', 'EndOfJob', ], ], 'ProcessingStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'ProcessingMaxRuntimeInSeconds', ], ], ], 'ProcessingVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 1, ], 'Processor' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'ProductId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ProductListings' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ProductionVariant' => [ 'type' => 'structure', 'required' => [ 'VariantName', 'ModelName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'InitialInstanceCount' => [ 'shape' => 'InitialTaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialVariantWeight' => [ 'shape' => 'VariantWeight', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'CoreDumpConfig' => [ 'shape' => 'ProductionVariantCoreDumpConfig', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'ProductionVariantVolumeSizeInGB', ], 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], 'EnableSSMAccess' => [ 'shape' => 'ProductionVariantSSMAccess', ], ], ], 'ProductionVariantAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantCoreDumpConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProductionVariantInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.12xlarge', 'ml.m5d.24xlarge', 'ml.c4.large', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.large', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.12xlarge', 'ml.r5.24xlarge', 'ml.r5d.large', 'ml.r5d.xlarge', 'ml.r5d.2xlarge', 'ml.r5d.4xlarge', 'ml.r5d.12xlarge', 'ml.r5d.24xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.p4d.24xlarge', 'ml.c7g.large', 'ml.c7g.xlarge', 'ml.c7g.2xlarge', 'ml.c7g.4xlarge', 'ml.c7g.8xlarge', 'ml.c7g.12xlarge', 'ml.c7g.16xlarge', 'ml.m6g.large', 'ml.m6g.xlarge', 'ml.m6g.2xlarge', 'ml.m6g.4xlarge', 'ml.m6g.8xlarge', 'ml.m6g.12xlarge', 'ml.m6g.16xlarge', 'ml.m6gd.large', 'ml.m6gd.xlarge', 'ml.m6gd.2xlarge', 'ml.m6gd.4xlarge', 'ml.m6gd.8xlarge', 'ml.m6gd.12xlarge', 'ml.m6gd.16xlarge', 'ml.c6g.large', 'ml.c6g.xlarge', 'ml.c6g.2xlarge', 'ml.c6g.4xlarge', 'ml.c6g.8xlarge', 'ml.c6g.12xlarge', 'ml.c6g.16xlarge', 'ml.c6gd.large', 'ml.c6gd.xlarge', 'ml.c6gd.2xlarge', 'ml.c6gd.4xlarge', 'ml.c6gd.8xlarge', 'ml.c6gd.12xlarge', 'ml.c6gd.16xlarge', 'ml.c6gn.large', 'ml.c6gn.xlarge', 'ml.c6gn.2xlarge', 'ml.c6gn.4xlarge', 'ml.c6gn.8xlarge', 'ml.c6gn.12xlarge', 'ml.c6gn.16xlarge', 'ml.r6g.large', 'ml.r6g.xlarge', 'ml.r6g.2xlarge', 'ml.r6g.4xlarge', 'ml.r6g.8xlarge', 'ml.r6g.12xlarge', 'ml.r6g.16xlarge', 'ml.r6gd.large', 'ml.r6gd.xlarge', 'ml.r6gd.2xlarge', 'ml.r6gd.4xlarge', 'ml.r6gd.8xlarge', 'ml.r6gd.12xlarge', 'ml.r6gd.16xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.inf2.xlarge', 'ml.inf2.8xlarge', 'ml.inf2.24xlarge', 'ml.inf2.48xlarge', ], ], 'ProductionVariantList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariant', ], 'max' => 10, 'min' => 1, ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantSSMAccess' => [ 'type' => 'boolean', ], 'ProductionVariantServerlessConfig' => [ 'type' => 'structure', 'required' => [ 'MemorySizeInMB', 'MaxConcurrency', ], 'members' => [ 'MemorySizeInMB' => [ 'shape' => 'ServerlessMemorySizeInMB', ], 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'VariantStatus', ], 'StatusMessage' => [ 'shape' => 'VariantStatusMessage', ], 'StartTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProductionVariantStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantStatus', ], 'max' => 5, 'min' => 0, ], 'ProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'ProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantSummary', ], 'min' => 1, ], 'ProductionVariantVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 512, 'min' => 1, ], 'ProfilerConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'ProfilerRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'ProfilerRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProfilerRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'ProfilingIntervalInMilliseconds' => [ 'type' => 'long', ], 'ProfilingParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'ProfilingStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ProgrammingLang' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'Project' => [ 'type' => 'structure', 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Tags' => [ 'shape' => 'TagList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'ProjectArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:project:.*', ], 'ProjectEntityName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'ProjectId' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'ProjectSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ProjectSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ProjectStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'CreateInProgress', 'CreateCompleted', 'CreateFailed', 'DeleteInProgress', 'DeleteFailed', 'DeleteCompleted', 'UpdateInProgress', 'UpdateCompleted', 'UpdateFailed', ], ], 'ProjectSummary' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ProjectArn', 'ProjectId', 'CreationTime', 'ProjectStatus', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], ], ], 'ProjectSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProjectSummary', ], ], 'PropertyNameHint' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'pattern' => '.*', ], 'PropertyNameQuery' => [ 'type' => 'structure', 'required' => [ 'PropertyNameHint', ], 'members' => [ 'PropertyNameHint' => [ 'shape' => 'PropertyNameHint', ], ], ], 'PropertyNameSuggestion' => [ 'type' => 'structure', 'members' => [ 'PropertyName' => [ 'shape' => 'ResourcePropertyName', ], ], ], 'PropertyNameSuggestionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyNameSuggestion', ], ], 'ProvisionedProductStatusMessage' => [ 'type' => 'string', 'pattern' => '.*', ], 'ProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ProvisioningParameterKey', ], 'Value' => [ 'shape' => 'ProvisioningParameterValue', ], ], ], 'ProvisioningParameterKey' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '.*', ], 'ProvisioningParameterValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningParameter', ], ], 'PublicWorkforceTaskPrice' => [ 'type' => 'structure', 'members' => [ 'AmountInUsd' => [ 'shape' => 'USD', ], ], ], 'PutModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ResourcePolicy', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'PutModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'QualityCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckStatistics' => [ 'shape' => 'String1024', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineStatistics' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'QueryFilters' => [ 'type' => 'structure', 'members' => [ 'Types' => [ 'shape' => 'QueryTypes', ], 'LineageTypes' => [ 'shape' => 'QueryLineageTypes', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedAfter' => [ 'shape' => 'Timestamp', ], 'Properties' => [ 'shape' => 'QueryProperties', ], ], ], 'QueryLineageMaxDepth' => [ 'type' => 'integer', 'max' => 10, ], 'QueryLineageMaxResults' => [ 'type' => 'integer', 'max' => 50, ], 'QueryLineageRequest' => [ 'type' => 'structure', 'members' => [ 'StartArns' => [ 'shape' => 'QueryLineageStartArns', ], 'Direction' => [ 'shape' => 'Direction', ], 'IncludeEdges' => [ 'shape' => 'Boolean', ], 'Filters' => [ 'shape' => 'QueryFilters', ], 'MaxDepth' => [ 'shape' => 'QueryLineageMaxDepth', ], 'MaxResults' => [ 'shape' => 'QueryLineageMaxResults', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageResponse' => [ 'type' => 'structure', 'members' => [ 'Vertices' => [ 'shape' => 'Vertices', ], 'Edges' => [ 'shape' => 'Edges', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageStartArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationEntityArn', ], 'max' => 1, 'min' => 0, ], 'QueryLineageTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageType', ], 'max' => 4, ], 'QueryProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'String256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 5, ], 'QueryTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String40', ], 'max' => 5, ], 'RSessionAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], ], ], 'RStudioServerProAccessStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'RStudioServerProAppSettings' => [ 'type' => 'structure', 'members' => [ 'AccessStatus' => [ 'shape' => 'RStudioServerProAccessStatus', ], 'UserGroup' => [ 'shape' => 'RStudioServerProUserGroup', ], ], ], 'RStudioServerProDomainSettings' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], ], ], 'RStudioServerProUserGroup' => [ 'type' => 'string', 'enum' => [ 'R_STUDIO_ADMIN', 'R_STUDIO_USER', ], ], 'RandomSeed' => [ 'type' => 'integer', 'min' => 0, ], 'RealTimeInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'TaskCount', ], ], ], 'RealTimeInferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationId', 'InstanceType', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'RealTimeInferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeInferenceRecommendation', ], 'max' => 3, 'min' => 0, ], 'RealtimeInferenceInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantInstanceType', ], ], 'RecommendationFailureReason' => [ 'type' => 'string', ], 'RecommendationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/.*', ], 'RecommendationJobCompilationJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'RecommendationJobCompiledOutputConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputUri' => [ 'shape' => 'S3Uri', ], ], ], 'RecommendationJobContainerConfig' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'String', ], 'PayloadConfig' => [ 'shape' => 'RecommendationJobPayloadConfig', ], 'NearestModelName' => [ 'shape' => 'String', ], 'SupportedInstanceTypes' => [ 'shape' => 'RecommendationJobSupportedInstanceTypes', ], 'DataInputConfig' => [ 'shape' => 'RecommendationJobDataInputConfig', ], 'SupportedEndpointType' => [ 'shape' => 'RecommendationJobSupportedEndpointType', ], ], ], 'RecommendationJobDataInputConfig' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'RecommendationJobDescription' => [ 'type' => 'string', 'max' => 128, ], 'RecommendationJobInferenceBenchmark' => [ 'type' => 'structure', 'required' => [ 'ModelConfiguration', ], 'members' => [ 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'FailureReason' => [ 'shape' => 'RecommendationFailureReason', ], 'EndpointMetrics' => [ 'shape' => 'InferenceMetrics', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'RecommendationJobInputConfig' => [ 'type' => 'structure', 'members' => [ 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'JobDurationInSeconds' => [ 'shape' => 'JobDurationInSeconds', ], 'TrafficPattern' => [ 'shape' => 'TrafficPattern', ], 'ResourceLimit' => [ 'shape' => 'RecommendationJobResourceLimit', ], 'EndpointConfigurations' => [ 'shape' => 'EndpointInputConfigurations', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ContainerConfig' => [ 'shape' => 'RecommendationJobContainerConfig', ], 'Endpoints' => [ 'shape' => 'Endpoints', ], 'VpcConfig' => [ 'shape' => 'RecommendationJobVpcConfig', ], 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'RecommendationJobName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'RecommendationJobOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CompiledOutputConfig' => [ 'shape' => 'RecommendationJobCompiledOutputConfig', ], ], ], 'RecommendationJobPayloadConfig' => [ 'type' => 'structure', 'members' => [ 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'SupportedContentTypes' => [ 'shape' => 'RecommendationJobSupportedContentTypes', ], ], ], 'RecommendationJobResourceLimit' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTests' => [ 'shape' => 'MaxNumberOfTests', ], 'MaxParallelOfTests' => [ 'shape' => 'MaxParallelOfTests', ], ], ], 'RecommendationJobStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'RecommendationJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatencyThresholds' => [ 'shape' => 'ModelLatencyThresholds', ], 'FlatInvocations' => [ 'shape' => 'FlatInvocations', ], ], ], 'RecommendationJobSupportedContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RecommendationJobSupportedEndpointType' => [ 'type' => 'string', 'enum' => [ 'RealTime', 'Serverless', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RecommendationJobType' => [ 'type' => 'string', 'enum' => [ 'Default', 'Advanced', ], ], 'RecommendationJobVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'RecommendationJobVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'RecommendationJobVpcSubnets', ], ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'RecommendationJobVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'RecommendationMetrics' => [ 'type' => 'structure', 'required' => [ 'CostPerHour', 'CostPerInference', 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'CostPerHour' => [ 'shape' => 'Float', ], 'CostPerInference' => [ 'shape' => 'Float', ], 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], 'CpuUtilization' => [ 'shape' => 'UtilizationMetric', ], 'MemoryUtilization' => [ 'shape' => 'UtilizationMetric', ], 'ModelSetupTime' => [ 'shape' => 'ModelSetupTime', ], ], ], 'RecommendationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'NOT_APPLICABLE', ], ], 'RecommendationStepType' => [ 'type' => 'string', 'enum' => [ 'BENCHMARK', ], ], 'RecordWrapper' => [ 'type' => 'string', 'enum' => [ 'None', 'RecordIO', ], ], 'RedshiftClusterId' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatabase' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'Database', 'DbUser', 'QueryString', 'ClusterRoleArn', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'ClusterId' => [ 'shape' => 'RedshiftClusterId', ], 'Database' => [ 'shape' => 'RedshiftDatabase', ], 'DbUser' => [ 'shape' => 'RedshiftUserName', ], 'QueryString' => [ 'shape' => 'RedshiftQueryString', ], 'ClusterRoleArn' => [ 'shape' => 'RoleArn', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'RedshiftResultFormat', ], 'OutputCompression' => [ 'shape' => 'RedshiftResultCompressionType', ], ], ], 'RedshiftQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'RedshiftResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'GZIP', 'BZIP2', 'ZSTD', 'SNAPPY', ], ], 'RedshiftResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'CSV', ], ], 'RedshiftUserName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'RegisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RegisterModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ReleaseNotes' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'RenderUiTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'Task', 'RoleArn', ], 'members' => [ 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Task' => [ 'shape' => 'RenderableTask', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'RenderUiTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'RenderedContent', 'Errors', ], 'members' => [ 'RenderedContent' => [ 'shape' => 'String', ], 'Errors' => [ 'shape' => 'RenderingErrorList', ], ], ], 'RenderableTask' => [ 'type' => 'structure', 'required' => [ 'Input', ], 'members' => [ 'Input' => [ 'shape' => 'TaskInput', ], ], ], 'RenderingError' => [ 'type' => 'structure', 'required' => [ 'Code', 'Message', ], 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'RenderingErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RenderingError', ], ], 'RepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'RepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryCredentialsProviderArn', ], 'members' => [ 'RepositoryCredentialsProviderArn' => [ 'shape' => 'RepositoryCredentialsProviderArn', ], ], ], 'RepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'RepositoryUrl' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$', ], 'ResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+', ], 'ResourceCatalog' => [ 'type' => 'structure', 'required' => [ 'ResourceCatalogArn', 'ResourceCatalogName', 'Description', 'CreationTime', ], 'members' => [ 'ResourceCatalogArn' => [ 'shape' => 'ResourceCatalogArn', ], 'ResourceCatalogName' => [ 'shape' => 'ResourceCatalogName', ], 'Description' => [ 'shape' => 'ResourceCatalogDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ResourceCatalogArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:sagemaker-catalog/.*', ], 'ResourceCatalogDescription' => [ 'type' => 'string', 'max' => 256, ], 'ResourceCatalogList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceCatalog', ], ], 'ResourceCatalogName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ResourceCatalogSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ResourceCatalogSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ResourceConfig' => [ 'type' => 'structure', 'required' => [ 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroups', ], 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], ], ], 'ResourceConfigForUpdate' => [ 'type' => 'structure', 'required' => [ 'KeepAlivePeriodInSeconds', ], 'members' => [ 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], ], ], 'ResourceId' => [ 'type' => 'string', 'max' => 32, ], 'ResourceInUse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimits' => [ 'type' => 'structure', 'required' => [ 'MaxParallelTrainingJobs', ], 'members' => [ 'MaxNumberOfTrainingJobs' => [ 'shape' => 'MaxNumberOfTrainingJobs', ], 'MaxParallelTrainingJobs' => [ 'shape' => 'MaxParallelTrainingJobs', ], 'MaxRuntimeInSeconds' => [ 'shape' => 'HyperParameterTuningMaxRuntimeInSeconds', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourcePolicyString' => [ 'type' => 'string', 'max' => 20480, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'ResourcePropertyName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'ResourceSpec' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageArn' => [ 'shape' => 'ImageArn', ], 'SageMakerImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'InstanceType' => [ 'shape' => 'AppInstanceType', ], 'LifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'TrainingJob', 'Experiment', 'ExperimentTrial', 'ExperimentTrialComponent', 'Endpoint', 'ModelPackage', 'ModelPackageGroup', 'Pipeline', 'PipelineExecution', 'FeatureGroup', 'Project', 'FeatureMetadata', 'HyperParameterTuningJob', 'ModelCard', 'Model', ], ], 'ResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'ResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResponseMIMEType', ], ], 'RetentionPolicy' => [ 'type' => 'structure', 'members' => [ 'HomeEfsFileSystem' => [ 'shape' => 'RetentionType', ], ], ], 'RetentionType' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Delete', ], ], 'RetryPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'RetryPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'RetryStrategy' => [ 'type' => 'structure', 'required' => [ 'MaximumRetryAttempts', ], 'members' => [ 'MaximumRetryAttempts' => [ 'shape' => 'MaximumRetryAttempts', ], ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'RollingUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'MaximumBatchSize', 'WaitIntervalInSeconds', ], 'members' => [ 'MaximumBatchSize' => [ 'shape' => 'CapacitySize', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], 'RollbackMaximumBatchSize' => [ 'shape' => 'CapacitySize', ], ], ], 'RootAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'RuleConfigurationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'RuleEvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'NoIssuesFound', 'IssuesFound', 'Error', 'Stopping', 'Stopped', ], ], 'RuleParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 100, 'min' => 0, ], 'S3DataDistribution' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'S3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'S3DataDistributionType' => [ 'shape' => 'S3DataDistribution', ], 'AttributeNames' => [ 'shape' => 'AttributeNames', ], 'InstanceGroupNames' => [ 'shape' => 'InstanceGroupNames', ], ], ], 'S3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'S3ModelDataSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', 'CompressionType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3ModelUri', ], 'S3DataType' => [ 'shape' => 'S3ModelDataType', ], 'CompressionType' => [ 'shape' => 'ModelCompressionType', ], ], ], 'S3ModelDataType' => [ 'type' => 'string', 'enum' => [ 'S3Prefix', 'S3Object', ], ], 'S3ModelUri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3OutputPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3StorageConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ResolvedOutputS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'SageMakerImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(?!^[.-])^([a-zA-Z0-9-_.]+)$', ], 'SageMakerImageVersionAliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], 'SagemakerServicecatalogStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'SampleWeightAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_-]+$', ], 'SamplingPercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ScheduleConfig' => [ 'type' => 'structure', 'required' => [ 'ScheduleExpression', ], 'members' => [ 'ScheduleExpression' => [ 'shape' => 'ScheduleExpression', ], ], ], 'ScheduleExpression' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ScheduleStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Failed', 'Scheduled', 'Stopped', ], ], 'SearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'NestedFilters' => [ 'shape' => 'NestedFiltersList', ], 'SubExpressions' => [ 'shape' => 'SearchExpressionList', ], 'Operator' => [ 'shape' => 'BooleanOperator', ], ], ], 'SearchExpressionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchExpression', ], 'max' => 20, 'min' => 1, ], 'SearchRecord' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'Experiment' => [ 'shape' => 'Experiment', ], 'Trial' => [ 'shape' => 'Trial', ], 'TrialComponent' => [ 'shape' => 'TrialComponent', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ModelPackage' => [ 'shape' => 'ModelPackage', ], 'ModelPackageGroup' => [ 'shape' => 'ModelPackageGroup', ], 'Pipeline' => [ 'shape' => 'Pipeline', ], 'PipelineExecution' => [ 'shape' => 'PipelineExecution', ], 'FeatureGroup' => [ 'shape' => 'FeatureGroup', ], 'Project' => [ 'shape' => 'Project', ], 'FeatureMetadata' => [ 'shape' => 'FeatureMetadata', ], 'HyperParameterTuningJob' => [ 'shape' => 'HyperParameterTuningJobSearchEntity', ], 'Model' => [ 'shape' => 'ModelDashboardModel', ], 'ModelCard' => [ 'shape' => 'ModelCard', ], ], ], 'SearchRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SearchExpression' => [ 'shape' => 'SearchExpression', ], 'SortBy' => [ 'shape' => 'ResourcePropertyName', ], 'SortOrder' => [ 'shape' => 'SearchSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CrossAccountFilterOption' => [ 'shape' => 'CrossAccountFilterOption', ], ], ], 'SearchResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'SearchResultsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SearchResultsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchRecord', ], ], 'SearchSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'LaunchingMLInstances', 'PreparingTrainingStack', 'Downloading', 'DownloadingTrainingImage', 'Training', 'Uploading', 'Stopping', 'Stopped', 'MaxRuntimeExceeded', 'Completed', 'Failed', 'Interrupted', 'MaxWaitTimeExceeded', 'Updating', 'Restarting', ], ], 'SecondaryStatusTransition' => [ 'type' => 'structure', 'required' => [ 'Status', 'StartTime', ], 'members' => [ 'Status' => [ 'shape' => 'SecondaryStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'SecondaryStatusTransitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecondaryStatusTransition', ], ], 'SecretArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*', ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, ], 'Seed' => [ 'type' => 'long', ], 'SelectedStep' => [ 'type' => 'structure', 'required' => [ 'StepName', ], 'members' => [ 'StepName' => [ 'shape' => 'String256', ], ], ], 'SelectedStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectedStep', ], 'max' => 50, 'min' => 1, ], 'SelectiveExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'SourcePipelineExecutionArn', 'SelectedSteps', ], 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'SelectedSteps' => [ 'shape' => 'SelectedStepList', ], ], ], 'SelectiveExecutionResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'FailureReason' => [ 'shape' => 'String256', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepFailureResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'ServerlessMaxConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServerlessMemorySizeInMB' => [ 'type' => 'integer', 'max' => 6144, 'min' => 1024, ], 'ServerlessProvisionedConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServiceCatalogEntityId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-]*', ], 'ServiceCatalogProvisionedProductDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisionedProductStatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], ], ], 'ServiceCatalogProvisioningDetails' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'ProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'PathId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'SessionExpirationDurationInSeconds' => [ 'type' => 'integer', 'max' => 43200, 'min' => 1800, ], 'ShadowModeConfig' => [ 'type' => 'structure', 'required' => [ 'SourceModelVariantName', 'ShadowModelVariants', ], 'members' => [ 'SourceModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'ShadowModelVariants' => [ 'shape' => 'ShadowModelVariantConfigList', ], ], ], 'ShadowModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ShadowModelVariantName', 'SamplingPercentage', ], 'members' => [ 'ShadowModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'SamplingPercentage' => [ 'shape' => 'Percentage', ], ], ], 'ShadowModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShadowModelVariantConfig', ], 'max' => 1, 'min' => 1, ], 'SharingSettings' => [ 'type' => 'structure', 'members' => [ 'NotebookOutputOption' => [ 'shape' => 'NotebookOutputOption', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ShuffleConfig' => [ 'type' => 'structure', 'required' => [ 'Seed', ], 'members' => [ 'Seed' => [ 'shape' => 'Seed', ], ], ], 'SingleSignOnUserIdentifier' => [ 'type' => 'string', 'pattern' => 'UserName', ], 'SnsTopicArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]+', ], 'SortActionsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortArtifactsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'SortAssociationsBy' => [ 'type' => 'string', 'enum' => [ 'SourceArn', 'DestinationArn', 'SourceType', 'DestinationType', 'CreationTime', ], ], 'SortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortContextsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortInferenceExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortLineageGroupsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SortPipelineExecutionsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'PipelineExecutionArn', ], ], 'SortPipelinesBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialComponentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SourceAlgorithm' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'ModelDataUrl' => [ 'shape' => 'Url', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'SourceAlgorithmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceAlgorithm', ], 'max' => 1, 'min' => 1, ], 'SourceAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'SourceAlgorithms', ], 'members' => [ 'SourceAlgorithms' => [ 'shape' => 'SourceAlgorithmList', ], ], ], 'SourceIpConfig' => [ 'type' => 'structure', 'required' => [ 'Cidrs', ], 'members' => [ 'Cidrs' => [ 'shape' => 'Cidrs', ], ], ], 'SourceType' => [ 'type' => 'string', 'max' => 128, ], 'SourceUri' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'SpaceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/.*', ], 'SpaceDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'SpaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpaceDetails', ], ], 'SpaceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'SpaceSettings' => [ 'type' => 'structure', 'members' => [ 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], ], ], 'SpaceSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'SpaceStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'SpawnRate' => [ 'type' => 'integer', 'min' => 0, ], 'SplitType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', 'RecordIO', 'TFRecord', ], ], 'StageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'READYTODEPLOY', 'STARTING', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'Stairs' => [ 'type' => 'structure', 'members' => [ 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], 'NumberOfSteps' => [ 'shape' => 'NumberOfSteps', ], 'UsersPerStep' => [ 'shape' => 'UsersPerStep', ], ], ], 'StartEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StartInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'StartInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StartMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StartNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StartPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'StartPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'StatusDetails' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'StatusMessage' => [ 'type' => 'string', ], 'StepDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'StepDisplayName' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'StepName' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'StepStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'StopAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'StopCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'StopInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'ModelVariantActions', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'ModelVariantActions' => [ 'shape' => 'ModelVariantActionMap', ], 'DesiredModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DesiredState' => [ 'shape' => 'InferenceExperimentStopDesiredState', ], 'Reason' => [ 'shape' => 'InferenceExperimentStatusReason', ], ], ], 'StopInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StopInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'StopLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'StopMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StopNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StopPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'StopPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'StopProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'StopTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'StopTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'StoppingCondition' => [ 'type' => 'structure', 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MaxRuntimeInSeconds', ], 'MaxWaitTimeInSeconds' => [ 'shape' => 'MaxWaitTimeInSeconds', ], ], ], 'String' => [ 'type' => 'string', ], 'String1024' => [ 'type' => 'string', 'max' => 1024, ], 'String128' => [ 'type' => 'string', 'max' => 128, ], 'String200' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '.+', ], 'String2048' => [ 'type' => 'string', 'max' => 2048, ], 'String256' => [ 'type' => 'string', 'max' => 256, ], 'String3072' => [ 'type' => 'string', 'max' => 3072, ], 'String40' => [ 'type' => 'string', 'max' => 40, ], 'String64' => [ 'type' => 'string', 'max' => 64, ], 'String8192' => [ 'type' => 'string', 'max' => 8192, ], 'StringParameterValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'StudioLifecycleConfigAppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', ], ], 'StudioLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*', ], 'StudioLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'StudioLifecycleConfigDetails' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'StudioLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'StudioLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'StudioLifecycleConfigsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigDetails', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'Subnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 16, 'min' => 1, ], 'SubscribedWorkteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MarketplaceTitle' => [ 'shape' => 'String200', ], 'SellerName' => [ 'shape' => 'String', ], 'MarketplaceDescription' => [ 'shape' => 'String200', ], 'ListingId' => [ 'shape' => 'String', ], ], ], 'SubscribedWorkteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubscribedWorkteam', ], ], 'Success' => [ 'type' => 'boolean', ], 'SuggestionQuery' => [ 'type' => 'structure', 'members' => [ 'PropertyNameQuery' => [ 'shape' => 'PropertyNameQuery', ], ], ], 'TableFormat' => [ 'type' => 'string', 'enum' => [ 'Glue', 'Iceberg', ], ], 'TableName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'TabularJobConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'CandidateGenerationConfig' => [ 'shape' => 'CandidateGenerationConfig', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'TabularResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'ProblemType' => [ 'shape' => 'ProblemType', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TargetAttributeName' => [ 'type' => 'string', 'min' => 1, ], 'TargetDevice' => [ 'type' => 'string', 'enum' => [ 'lambda', 'ml_m4', 'ml_m5', 'ml_c4', 'ml_c5', 'ml_p2', 'ml_p3', 'ml_g4dn', 'ml_inf1', 'ml_inf2', 'ml_trn1', 'ml_eia2', 'jetson_tx1', 'jetson_tx2', 'jetson_nano', 'jetson_xavier', 'rasp3b', 'imx8qm', 'deeplens', 'rk3399', 'rk3288', 'aisage', 'sbe_c', 'qcs605', 'qcs603', 'sitara_am57x', 'amba_cv2', 'amba_cv22', 'amba_cv25', 'x86_win32', 'x86_win64', 'coreml', 'jacinto_tda4vm', 'imx8mplus', ], ], 'TargetLabelColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TargetObjectiveMetricValue' => [ 'type' => 'float', ], 'TargetPlatform' => [ 'type' => 'structure', 'required' => [ 'Os', 'Arch', ], 'members' => [ 'Os' => [ 'shape' => 'TargetPlatformOs', ], 'Arch' => [ 'shape' => 'TargetPlatformArch', ], 'Accelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], ], ], 'TargetPlatformAccelerator' => [ 'type' => 'string', 'enum' => [ 'INTEL_GRAPHICS', 'MALI', 'NVIDIA', 'NNA', ], ], 'TargetPlatformArch' => [ 'type' => 'string', 'enum' => [ 'X86_64', 'X86', 'ARM64', 'ARM_EABI', 'ARM_EABIHF', ], ], 'TargetPlatformOs' => [ 'type' => 'string', 'enum' => [ 'ANDROID', 'LINUX', ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 60, ], 'TaskCount' => [ 'type' => 'integer', 'min' => 0, ], 'TaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'TaskInput' => [ 'type' => 'string', 'max' => 128000, 'min' => 2, 'pattern' => '[\\S\\s]+', ], 'TaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'TaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskKeyword', ], 'max' => 5, 'min' => 1, ], 'TaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'TaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'TemplateContent' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'TemplateContentSha256' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, ], 'TemplateUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TensorBoardAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'TensorBoardOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'TenthFractionsOfACent' => [ 'type' => 'integer', 'max' => 9, 'min' => 0, ], 'TerminationWaitInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'TextClassificationJobConfig' => [ 'type' => 'structure', 'required' => [ 'ContentColumn', 'TargetLabelColumn', ], 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ContentColumn' => [ 'shape' => 'ContentColumn', ], 'TargetLabelColumn' => [ 'shape' => 'TargetLabelColumn', ], ], ], 'ThingName' => [ 'type' => 'string', 'max' => 128, 'pattern' => '[a-zA-Z0-9:_-]+', ], 'TimeSeriesConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', 'TimestampAttributeName', 'ItemIdentifierAttributeName', ], 'members' => [ 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'TimestampAttributeName' => [ 'shape' => 'TimestampAttributeName', ], 'ItemIdentifierAttributeName' => [ 'shape' => 'ItemIdentifierAttributeName', ], 'GroupingAttributeNames' => [ 'shape' => 'GroupingAttributeNames', ], ], ], 'TimeSeriesForecastingJobConfig' => [ 'type' => 'structure', 'required' => [ 'ForecastFrequency', 'ForecastHorizon', 'TimeSeriesConfig', ], 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ForecastFrequency' => [ 'shape' => 'ForecastFrequency', ], 'ForecastHorizon' => [ 'shape' => 'ForecastHorizon', ], 'ForecastQuantiles' => [ 'shape' => 'ForecastQuantiles', ], 'Transformations' => [ 'shape' => 'TimeSeriesTransformations', ], 'TimeSeriesConfig' => [ 'shape' => 'TimeSeriesConfig', ], ], ], 'TimeSeriesForecastingSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'AmazonForecastRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'TimeSeriesTransformations' => [ 'type' => 'structure', 'members' => [ 'Filling' => [ 'shape' => 'FillingTransformations', ], 'Aggregation' => [ 'shape' => 'AggregationTransformations', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TimestampAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TrafficDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TrafficPattern' => [ 'type' => 'structure', 'members' => [ 'TrafficType' => [ 'shape' => 'TrafficType', ], 'Phases' => [ 'shape' => 'Phases', ], 'Stairs' => [ 'shape' => 'Stairs', ], ], ], 'TrafficRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'Type', 'WaitIntervalInSeconds', ], 'members' => [ 'Type' => [ 'shape' => 'TrafficRoutingConfigType', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'CanarySize' => [ 'shape' => 'CapacitySize', ], 'LinearStepSize' => [ 'shape' => 'CapacitySize', ], ], ], 'TrafficRoutingConfigType' => [ 'type' => 'string', 'enum' => [ 'ALL_AT_ONCE', 'CANARY', 'LINEAR', ], ], 'TrafficType' => [ 'type' => 'string', 'enum' => [ 'PHASES', 'STAIRS', ], ], 'TrainingContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerArgument', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerEntrypointString', ], 'max' => 10, 'min' => 1, ], 'TrainingContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'TrainingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrainingEnvironmentKey', ], 'value' => [ 'shape' => 'TrainingEnvironmentValue', ], 'max' => 48, ], 'TrainingEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'TrainingImageConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryAccessMode', ], 'members' => [ 'TrainingRepositoryAccessMode' => [ 'shape' => 'TrainingRepositoryAccessMode', ], 'TrainingRepositoryAuthConfig' => [ 'shape' => 'TrainingRepositoryAuthConfig', ], ], ], 'TrainingInputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', 'FastFile', ], ], 'TrainingInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.p4d.24xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5n.xlarge', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', ], ], 'TrainingInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInstanceType', ], ], 'TrainingJob' => [ 'type' => 'structure', 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TrainingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/.*', ], 'TrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', 'InputDataConfig', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], ], ], 'TrainingJobEarlyStoppingType' => [ 'type' => 'string', 'enum' => [ 'Off', 'Auto', ], ], 'TrainingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TrainingJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'TrainingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrainingJobStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingJobStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Completed' => [ 'shape' => 'TrainingJobStatusCounter', ], 'InProgress' => [ 'shape' => 'TrainingJobStatusCounter', ], 'RetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'NonRetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'Stopped' => [ 'shape' => 'TrainingJobStatusCounter', ], ], ], 'TrainingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'TrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingJobSummary', ], ], 'TrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], ], ], 'TrainingRepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'TrainingRepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryCredentialsProviderArn', ], 'members' => [ 'TrainingRepositoryCredentialsProviderArn' => [ 'shape' => 'TrainingRepositoryCredentialsProviderArn', ], ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:.*', ], 'TrainingSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingImage', 'SupportedTrainingInstanceTypes', 'TrainingChannels', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'ContainerImage', ], 'TrainingImageDigest' => [ 'shape' => 'ImageDigest', ], 'SupportedHyperParameters' => [ 'shape' => 'HyperParameterSpecifications', ], 'SupportedTrainingInstanceTypes' => [ 'shape' => 'TrainingInstanceTypes', ], 'SupportsDistributedTraining' => [ 'shape' => 'Boolean', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'TrainingChannels' => [ 'shape' => 'ChannelSpecifications', ], 'SupportedTuningJobObjectiveMetrics' => [ 'shape' => 'HyperParameterTuningJobObjectives', ], ], ], 'TrainingTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TransformDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'TransformS3DataSource', ], ], ], 'TransformEnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]{0,1023}', ], 'TransformEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformEnvironmentKey', ], 'value' => [ 'shape' => 'TransformEnvironmentValue', ], 'max' => 16, ], 'TransformEnvironmentValue' => [ 'type' => 'string', 'max' => 10240, 'pattern' => '[\\S\\s]*', ], 'TransformInput' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'TransformDataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'SplitType' => [ 'shape' => 'SplitType', ], ], ], 'TransformInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'TransformInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'TransformInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformInstanceType', ], 'min' => 1, ], 'TransformJob' => [ 'type' => 'structure', 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TransformJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*', ], 'TransformJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], ], ], 'TransformJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TransformJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TransformJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TransformJobArn', ], ], ], 'TransformJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformJobSummary', ], ], 'TransformJobSummary' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'CreationTime', 'TransformJobStatus', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'TransformOutput' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'Accept' => [ 'shape' => 'Accept', ], 'AssembleWith' => [ 'shape' => 'AssemblyType', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformResources' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TransformInstanceType', ], 'InstanceCount' => [ 'shape' => 'TransformInstanceCount', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'TransformationAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Trial' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSimpleSummaries', ], ], ], 'TrialArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/.*', ], 'TrialComponent' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'SourceDetail' => [ 'shape' => 'TrialComponentSourceDetail', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'Parents' => [ 'shape' => 'Parents', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'TrialComponentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/.*', ], 'TrialComponentArtifact' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'MediaType' => [ 'shape' => 'MediaType', ], 'Value' => [ 'shape' => 'TrialComponentArtifactValue', ], ], ], 'TrialComponentArtifactValue' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'TrialComponentArtifacts' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey64', ], 'value' => [ 'shape' => 'TrialComponentArtifact', ], 'max' => 30, ], 'TrialComponentKey256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrialComponentKey64' => [ 'type' => 'string', 'max' => 64, 'pattern' => '.*', ], 'TrialComponentMetricSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentMetricSummary', ], ], 'TrialComponentMetricSummary' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TimeStamp' => [ 'shape' => 'Timestamp', ], 'Max' => [ 'shape' => 'OptionalDouble', ], 'Min' => [ 'shape' => 'OptionalDouble', ], 'Last' => [ 'shape' => 'OptionalDouble', ], 'Count' => [ 'shape' => 'OptionalInteger', ], 'Avg' => [ 'shape' => 'OptionalDouble', ], 'StdDev' => [ 'shape' => 'OptionalDouble', ], ], ], 'TrialComponentParameterValue' => [ 'type' => 'structure', 'members' => [ 'StringValue' => [ 'shape' => 'StringParameterValue', ], 'NumberValue' => [ 'shape' => 'DoubleParameterValue', ], ], ], 'TrialComponentParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey256', ], 'value' => [ 'shape' => 'TrialComponentParameterValue', ], 'max' => 150, ], 'TrialComponentPrimaryStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrialComponentSimpleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSimpleSummary', ], ], 'TrialComponentSimpleSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialComponentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialComponentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialComponentSourceDetail' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJob', ], 'TransformJob' => [ 'shape' => 'TransformJob', ], ], ], 'TrialComponentSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSource', ], ], 'TrialComponentStatus' => [ 'type' => 'structure', 'members' => [ 'PrimaryStatus' => [ 'shape' => 'TrialComponentPrimaryStatus', ], 'Message' => [ 'shape' => 'TrialComponentStatusMessage', ], ], ], 'TrialComponentStatusMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'TrialComponentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSummary', ], ], 'TrialComponentSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialSummary', ], ], 'TrialSummary' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialSource' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TtlDuration' => [ 'type' => 'structure', 'members' => [ 'Unit' => [ 'shape' => 'TtlDurationUnit', ], 'Value' => [ 'shape' => 'TtlDurationValue', ], ], ], 'TtlDurationUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', ], ], 'TtlDurationValue' => [ 'type' => 'integer', 'min' => 1, ], 'TuningJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'TargetObjectiveMetricValue' => [ 'shape' => 'TargetObjectiveMetricValue', ], 'BestObjectiveNotImproving' => [ 'shape' => 'BestObjectiveNotImproving', ], 'ConvergenceDetected' => [ 'shape' => 'ConvergenceDetected', ], ], ], 'TuningJobStepMetaData' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'USD' => [ 'type' => 'structure', 'members' => [ 'Dollars' => [ 'shape' => 'Dollars', ], 'Cents' => [ 'shape' => 'Cents', ], 'TenthFractionsOfACent' => [ 'shape' => 'TenthFractionsOfACent', ], ], ], 'UiConfig' => [ 'type' => 'structure', 'members' => [ 'UiTemplateS3Uri' => [ 'shape' => 'S3Uri', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'UiTemplate' => [ 'type' => 'structure', 'required' => [ 'Content', ], 'members' => [ 'Content' => [ 'shape' => 'TemplateContent', ], ], ], 'UiTemplateInfo' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'TemplateUrl', ], 'ContentSha256' => [ 'shape' => 'TemplateContentSha256', ], ], ], 'UpdateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'UpdateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], ], ], 'UpdateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'UpdateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'UpdateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfigForUpdate', ], ], ], 'UpdateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'UpdateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'UpdateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'UpdateDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], ], ], 'UpdateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettingsForUpdate' => [ 'shape' => 'DomainSettingsForUpdate', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], ], ], 'UpdateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], ], ], 'UpdateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'RetainAllVariantProperties' => [ 'shape' => 'Boolean', ], 'ExcludeRetainedVariantProperties' => [ 'shape' => 'VariantPropertyList', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'RetainDeploymentConfig' => [ 'shape' => 'Boolean', ], ], ], 'UpdateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'DesiredWeightsAndCapacities', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'DesiredWeightsAndCapacities' => [ 'shape' => 'DesiredWeightAndCapacityList', ], ], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], ], ], 'UpdateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'UpdateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureAdditions' => [ 'shape' => 'FeatureAdditions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfigUpdate', ], ], ], 'UpdateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'UpdateFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'ParameterAdditions' => [ 'shape' => 'FeatureParameterAdditions', ], 'ParameterRemovals' => [ 'shape' => 'FeatureParameterRemovals', ], ], ], 'UpdateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], ], ], 'UpdateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'UpdateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'DeleteProperties' => [ 'shape' => 'ImageDeletePropertyList', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'UpdateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'AliasesToAdd' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'AliasesToDelete' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'UpdateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'UpdateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], ], ], 'UpdateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'UpdateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], ], ], 'UpdateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'UpdateModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'CustomerMetadataPropertiesToRemove' => [ 'shape' => 'CustomerMetadataKeyList', ], 'AdditionalInferenceSpecificationsToAdd' => [ 'shape' => 'AdditionalInferenceSpecifications', ], ], ], 'UpdateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'UpdateMonitoringAlertRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'DatapointsToAlert', 'EvaluationPeriod', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], ], ], 'UpdateMonitoringAlertResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], ], ], 'UpdateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], ], ], 'UpdateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'UpdateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DisassociateLifecycleConfig' => [ 'shape' => 'DisassociateNotebookInstanceLifecycleConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DisassociateAcceleratorTypes' => [ 'shape' => 'DisassociateNotebookInstanceAcceleratorTypes', ], 'DisassociateDefaultCodeRepository' => [ 'shape' => 'DisassociateDefaultCodeRepository', ], 'DisassociateAdditionalCodeRepositories' => [ 'shape' => 'DisassociateAdditionalCodeRepositories', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'UpdatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'UpdateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'shape' => 'ServiceCatalogProvisioningUpdateDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'UpdateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], ], ], 'UpdateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], ], ], 'UpdateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'UpdateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfigForUpdate', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfigForUpdate', ], ], ], 'UpdateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'UpdateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'ParametersToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'InputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], ], ], 'UpdateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'UpdateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'UpdateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'UpdateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'UpdateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'UpdateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'UpdateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'UpdateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'UpdateWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Url' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'UserContext' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'String', ], 'UserProfileName' => [ 'shape' => 'String', ], 'DomainId' => [ 'shape' => 'String', ], 'IamIdentity' => [ 'shape' => 'IamIdentity', ], ], ], 'UserProfileArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/.*', ], 'UserProfileDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'UserProfileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProfileDetails', ], ], 'UserProfileName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'UserProfileSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'UserProfileStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'UserSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'SharingSettings' => [ 'shape' => 'SharingSettings', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'TensorBoardAppSettings' => [ 'shape' => 'TensorBoardAppSettings', ], 'RStudioServerProAppSettings' => [ 'shape' => 'RStudioServerProAppSettings', ], 'RSessionAppSettings' => [ 'shape' => 'RSessionAppSettings', ], 'CanvasAppSettings' => [ 'shape' => 'CanvasAppSettings', ], ], ], 'UsersPerStep' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'UtilizationMetric' => [ 'type' => 'float', 'min' => 0.0, ], 'ValidationFraction' => [ 'type' => 'float', 'max' => 1, 'min' => 0, ], 'VariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'VariantProperty' => [ 'type' => 'structure', 'required' => [ 'VariantPropertyType', ], 'members' => [ 'VariantPropertyType' => [ 'shape' => 'VariantPropertyType', ], ], ], 'VariantPropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantProperty', ], 'max' => 3, 'min' => 0, ], 'VariantPropertyType' => [ 'type' => 'string', 'enum' => [ 'DesiredInstanceCount', 'DesiredWeight', 'DataCaptureConfig', ], ], 'VariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'Deleting', 'ActivatingTraffic', 'Baking', ], ], 'VariantStatusMessage' => [ 'type' => 'string', 'max' => 1024, ], 'VariantWeight' => [ 'type' => 'float', 'min' => 0, ], 'VendorGuidance' => [ 'type' => 'string', 'enum' => [ 'NOT_PROVIDED', 'STABLE', 'TO_BE_ARCHIVED', 'ARCHIVED', ], ], 'VersionId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'VersionedArnOrName' => [ 'type' => 'string', 'max' => 176, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AssociationEntityArn', ], 'Type' => [ 'shape' => 'String40', ], 'LineageType' => [ 'shape' => 'LineageType', ], ], ], 'Vertices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Vertex', ], ], 'VolumeSizeInGB' => [ 'type' => 'integer', 'min' => 1, ], 'VpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'Subnets', ], ], ], 'VpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'VpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WaitIntervalInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'WarmPoolResourceStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Terminated', 'Reused', 'InUse', ], ], 'WarmPoolStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'WarmPoolResourceStatus', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'shape' => 'ResourceRetainedBillableTimeInSeconds', ], 'ReusedByJob' => [ 'shape' => 'TrainingJobName', ], ], ], 'Workforce' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', 'WorkforceArn', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'SubDomain' => [ 'shape' => 'String', ], 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfigForResponse', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigResponse', ], 'Status' => [ 'shape' => 'WorkforceStatus', ], 'FailureReason' => [ 'shape' => 'WorkforceFailureReason', ], ], ], 'WorkforceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/.*', ], 'WorkforceFailureReason' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'WorkforceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$', ], 'WorkforceSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^sg-[0-9a-z]*$', ], 'WorkforceSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WorkforceStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Updating', 'Deleting', 'Failed', 'Active', ], ], 'WorkforceSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^subnet-[0-9a-z]*$', ], 'WorkforceSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSubnetId', ], 'max' => 16, 'min' => 1, ], 'WorkforceVpcConfigRequest' => [ 'type' => 'structure', 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], ], ], 'WorkforceVpcConfigResponse' => [ 'type' => 'structure', 'required' => [ 'VpcId', 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], 'VpcEndpointId' => [ 'shape' => 'WorkforceVpcEndpointId', ], ], ], 'WorkforceVpcEndpointId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpce-[0-9a-z]*$', ], 'WorkforceVpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^vpc-[0-9a-z]*$', ], 'Workforces' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workforce', ], ], 'WorkspaceSettings' => [ 'type' => 'structure', 'members' => [ 'S3ArtifactPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'Workteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'WorkteamArn', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'ProductListingIds' => [ 'shape' => 'ProductListings', ], 'Description' => [ 'shape' => 'String200', ], 'SubDomain' => [ 'shape' => 'String', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'WorkteamArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/.*', ], 'WorkteamName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'Workteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workteam', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2017-07-24', 'endpointPrefix' => 'api.sagemaker', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'SageMaker', 'serviceFullName' => 'Amazon SageMaker Service', 'serviceId' => 'SageMaker', 'signatureVersion' => 'v4', 'signingName' => 'sagemaker', 'targetPrefix' => 'SageMaker', 'uid' => 'sagemaker-2017-07-24', ], 'operations' => [ 'AddAssociation' => [ 'name' => 'AddAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddAssociationRequest', ], 'output' => [ 'shape' => 'AddAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsInput', ], 'output' => [ 'shape' => 'AddTagsOutput', ], ], 'AssociateTrialComponent' => [ 'name' => 'AssociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateTrialComponentRequest', ], 'output' => [ 'shape' => 'AssociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'BatchDescribeModelPackage' => [ 'name' => 'BatchDescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDescribeModelPackageInput', ], 'output' => [ 'shape' => 'BatchDescribeModelPackageOutput', ], ], 'CreateAction' => [ 'name' => 'CreateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateActionRequest', ], 'output' => [ 'shape' => 'CreateActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAlgorithm' => [ 'name' => 'CreateAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAlgorithmInput', ], 'output' => [ 'shape' => 'CreateAlgorithmOutput', ], ], 'CreateApp' => [ 'name' => 'CreateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppRequest', ], 'output' => [ 'shape' => 'CreateAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateAppImageConfig' => [ 'name' => 'CreateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppImageConfigRequest', ], 'output' => [ 'shape' => 'CreateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateArtifact' => [ 'name' => 'CreateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateArtifactRequest', ], 'output' => [ 'shape' => 'CreateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJob' => [ 'name' => 'CreateAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobRequest', ], 'output' => [ 'shape' => 'CreateAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJobV2' => [ 'name' => 'CreateAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobV2Request', ], 'output' => [ 'shape' => 'CreateAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateCodeRepository' => [ 'name' => 'CreateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCodeRepositoryInput', ], 'output' => [ 'shape' => 'CreateCodeRepositoryOutput', ], ], 'CreateCompilationJob' => [ 'name' => 'CreateCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCompilationJobRequest', ], 'output' => [ 'shape' => 'CreateCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateContext' => [ 'name' => 'CreateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContextRequest', ], 'output' => [ 'shape' => 'CreateContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDataQualityJobDefinition' => [ 'name' => 'CreateDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateDeviceFleet' => [ 'name' => 'CreateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateEdgeDeploymentPlan' => [ 'name' => 'CreateEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'CreateEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgeDeploymentStage' => [ 'name' => 'CreateEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgePackagingJob' => [ 'name' => 'CreateEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgePackagingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpoint' => [ 'name' => 'CreateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointInput', ], 'output' => [ 'shape' => 'CreateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpointConfig' => [ 'name' => 'CreateEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointConfigInput', ], 'output' => [ 'shape' => 'CreateEndpointConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateExperiment' => [ 'name' => 'CreateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateExperimentRequest', ], 'output' => [ 'shape' => 'CreateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFeatureGroup' => [ 'name' => 'CreateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFeatureGroupRequest', ], 'output' => [ 'shape' => 'CreateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFlowDefinition' => [ 'name' => 'CreateFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFlowDefinitionRequest', ], 'output' => [ 'shape' => 'CreateFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHub' => [ 'name' => 'CreateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHubRequest', ], 'output' => [ 'shape' => 'CreateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateHumanTaskUi' => [ 'name' => 'CreateHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHumanTaskUiRequest', ], 'output' => [ 'shape' => 'CreateHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHyperParameterTuningJob' => [ 'name' => 'CreateHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'CreateHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImage' => [ 'name' => 'CreateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageRequest', ], 'output' => [ 'shape' => 'CreateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImageVersion' => [ 'name' => 'CreateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageVersionRequest', ], 'output' => [ 'shape' => 'CreateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateInferenceExperiment' => [ 'name' => 'CreateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'CreateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceRecommendationsJob' => [ 'name' => 'CreateInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'CreateInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateLabelingJob' => [ 'name' => 'CreateLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLabelingJobRequest', ], 'output' => [ 'shape' => 'CreateLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModel' => [ 'name' => 'CreateModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelInput', ], 'output' => [ 'shape' => 'CreateModelOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelBiasJobDefinition' => [ 'name' => 'CreateModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelCard' => [ 'name' => 'CreateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardRequest', ], 'output' => [ 'shape' => 'CreateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelCardExportJob' => [ 'name' => 'CreateModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardExportJobRequest', ], 'output' => [ 'shape' => 'CreateModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelExplainabilityJobDefinition' => [ 'name' => 'CreateModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelPackage' => [ 'name' => 'CreateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageInput', ], 'output' => [ 'shape' => 'CreateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelPackageGroup' => [ 'name' => 'CreateModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageGroupInput', ], 'output' => [ 'shape' => 'CreateModelPackageGroupOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelQualityJobDefinition' => [ 'name' => 'CreateModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateMonitoringSchedule' => [ 'name' => 'CreateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'CreateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateNotebookInstance' => [ 'name' => 'CreateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateNotebookInstanceLifecycleConfig' => [ 'name' => 'CreateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreatePipeline' => [ 'name' => 'CreatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePipelineRequest', ], 'output' => [ 'shape' => 'CreatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreatePresignedDomainUrl' => [ 'name' => 'CreatePresignedDomainUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedDomainUrlRequest', ], 'output' => [ 'shape' => 'CreatePresignedDomainUrlResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'CreatePresignedNotebookInstanceUrl' => [ 'name' => 'CreatePresignedNotebookInstanceUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlInput', ], 'output' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlOutput', ], ], 'CreateProcessingJob' => [ 'name' => 'CreateProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProcessingJobRequest', ], 'output' => [ 'shape' => 'CreateProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateProject' => [ 'name' => 'CreateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProjectInput', ], 'output' => [ 'shape' => 'CreateProjectOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateSpace' => [ 'name' => 'CreateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSpaceRequest', ], 'output' => [ 'shape' => 'CreateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateStudioLifecycleConfig' => [ 'name' => 'CreateStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'CreateStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateTrainingJob' => [ 'name' => 'CreateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrainingJobRequest', ], 'output' => [ 'shape' => 'CreateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTransformJob' => [ 'name' => 'CreateTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTransformJobRequest', ], 'output' => [ 'shape' => 'CreateTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTrial' => [ 'name' => 'CreateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialRequest', ], 'output' => [ 'shape' => 'CreateTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateTrialComponent' => [ 'name' => 'CreateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialComponentRequest', ], 'output' => [ 'shape' => 'CreateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateUserProfile' => [ 'name' => 'CreateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserProfileRequest', ], 'output' => [ 'shape' => 'CreateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateWorkforce' => [ 'name' => 'CreateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkforceRequest', ], 'output' => [ 'shape' => 'CreateWorkforceResponse', ], ], 'CreateWorkteam' => [ 'name' => 'CreateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkteamRequest', ], 'output' => [ 'shape' => 'CreateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeleteAction' => [ 'name' => 'DeleteAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteActionRequest', ], 'output' => [ 'shape' => 'DeleteActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAlgorithm' => [ 'name' => 'DeleteAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAlgorithmInput', ], ], 'DeleteApp' => [ 'name' => 'DeleteApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAppImageConfig' => [ 'name' => 'DeleteAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppImageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteArtifact' => [ 'name' => 'DeleteArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteArtifactRequest', ], 'output' => [ 'shape' => 'DeleteArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAssociation' => [ 'name' => 'DeleteAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAssociationRequest', ], 'output' => [ 'shape' => 'DeleteAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteCodeRepository' => [ 'name' => 'DeleteCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCodeRepositoryInput', ], ], 'DeleteContext' => [ 'name' => 'DeleteContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContextRequest', ], 'output' => [ 'shape' => 'DeleteContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDataQualityJobDefinition' => [ 'name' => 'DeleteDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDataQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDeviceFleet' => [ 'name' => 'DeleteDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteEdgeDeploymentPlan' => [ 'name' => 'DeleteEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentPlanRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEdgeDeploymentStage' => [ 'name' => 'DeleteEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEndpoint' => [ 'name' => 'DeleteEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointInput', ], ], 'DeleteEndpointConfig' => [ 'name' => 'DeleteEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointConfigInput', ], ], 'DeleteExperiment' => [ 'name' => 'DeleteExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteExperimentRequest', ], 'output' => [ 'shape' => 'DeleteExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFeatureGroup' => [ 'name' => 'DeleteFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFeatureGroupRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFlowDefinition' => [ 'name' => 'DeleteFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHub' => [ 'name' => 'DeleteHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHubContent' => [ 'name' => 'DeleteHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubContentRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHumanTaskUi' => [ 'name' => 'DeleteHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DeleteHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImage' => [ 'name' => 'DeleteImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageRequest', ], 'output' => [ 'shape' => 'DeleteImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImageVersion' => [ 'name' => 'DeleteImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageVersionRequest', ], 'output' => [ 'shape' => 'DeleteImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteInferenceExperiment' => [ 'name' => 'DeleteInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DeleteInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModel' => [ 'name' => 'DeleteModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelInput', ], ], 'DeleteModelBiasJobDefinition' => [ 'name' => 'DeleteModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelBiasJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelCard' => [ 'name' => 'DeleteModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelCardRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelExplainabilityJobDefinition' => [ 'name' => 'DeleteModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelExplainabilityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelPackage' => [ 'name' => 'DeleteModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroup' => [ 'name' => 'DeleteModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroupPolicy' => [ 'name' => 'DeleteModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupPolicyInput', ], ], 'DeleteModelQualityJobDefinition' => [ 'name' => 'DeleteModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteMonitoringSchedule' => [ 'name' => 'DeleteMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteNotebookInstance' => [ 'name' => 'DeleteNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceInput', ], ], 'DeleteNotebookInstanceLifecycleConfig' => [ 'name' => 'DeleteNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceLifecycleConfigInput', ], ], 'DeletePipeline' => [ 'name' => 'DeletePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePipelineRequest', ], 'output' => [ 'shape' => 'DeletePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteProject' => [ 'name' => 'DeleteProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProjectInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteSpace' => [ 'name' => 'DeleteSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSpaceRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteStudioLifecycleConfig' => [ 'name' => 'DeleteStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioLifecycleConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagsInput', ], 'output' => [ 'shape' => 'DeleteTagsOutput', ], ], 'DeleteTrial' => [ 'name' => 'DeleteTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialRequest', ], 'output' => [ 'shape' => 'DeleteTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteTrialComponent' => [ 'name' => 'DeleteTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialComponentRequest', ], 'output' => [ 'shape' => 'DeleteTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteUserProfile' => [ 'name' => 'DeleteUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserProfileRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteWorkforce' => [ 'name' => 'DeleteWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkforceRequest', ], 'output' => [ 'shape' => 'DeleteWorkforceResponse', ], ], 'DeleteWorkteam' => [ 'name' => 'DeleteWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkteamRequest', ], 'output' => [ 'shape' => 'DeleteWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeregisterDevices' => [ 'name' => 'DeregisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterDevicesRequest', ], ], 'DescribeAction' => [ 'name' => 'DescribeAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeActionRequest', ], 'output' => [ 'shape' => 'DescribeActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAlgorithm' => [ 'name' => 'DescribeAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAlgorithmInput', ], 'output' => [ 'shape' => 'DescribeAlgorithmOutput', ], ], 'DescribeApp' => [ 'name' => 'DescribeApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppRequest', ], 'output' => [ 'shape' => 'DescribeAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAppImageConfig' => [ 'name' => 'DescribeAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppImageConfigRequest', ], 'output' => [ 'shape' => 'DescribeAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeArtifact' => [ 'name' => 'DescribeArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeArtifactRequest', ], 'output' => [ 'shape' => 'DescribeArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJob' => [ 'name' => 'DescribeAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobRequest', ], 'output' => [ 'shape' => 'DescribeAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJobV2' => [ 'name' => 'DescribeAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobV2Request', ], 'output' => [ 'shape' => 'DescribeAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCodeRepository' => [ 'name' => 'DescribeCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCodeRepositoryInput', ], 'output' => [ 'shape' => 'DescribeCodeRepositoryOutput', ], ], 'DescribeCompilationJob' => [ 'name' => 'DescribeCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCompilationJobRequest', ], 'output' => [ 'shape' => 'DescribeCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeContext' => [ 'name' => 'DescribeContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContextRequest', ], 'output' => [ 'shape' => 'DescribeContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDataQualityJobDefinition' => [ 'name' => 'DescribeDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDevice' => [ 'name' => 'DescribeDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceRequest', ], 'output' => [ 'shape' => 'DescribeDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDeviceFleet' => [ 'name' => 'DescribeDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceFleetRequest', ], 'output' => [ 'shape' => 'DescribeDeviceFleetResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgeDeploymentPlan' => [ 'name' => 'DescribeEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'DescribeEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgePackagingJob' => [ 'name' => 'DescribeEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgePackagingJobRequest', ], 'output' => [ 'shape' => 'DescribeEdgePackagingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEndpoint' => [ 'name' => 'DescribeEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointInput', ], 'output' => [ 'shape' => 'DescribeEndpointOutput', ], ], 'DescribeEndpointConfig' => [ 'name' => 'DescribeEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointConfigInput', ], 'output' => [ 'shape' => 'DescribeEndpointConfigOutput', ], ], 'DescribeExperiment' => [ 'name' => 'DescribeExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExperimentRequest', ], 'output' => [ 'shape' => 'DescribeExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureGroup' => [ 'name' => 'DescribeFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureGroupRequest', ], 'output' => [ 'shape' => 'DescribeFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureMetadata' => [ 'name' => 'DescribeFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureMetadataRequest', ], 'output' => [ 'shape' => 'DescribeFeatureMetadataResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFlowDefinition' => [ 'name' => 'DescribeFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHub' => [ 'name' => 'DescribeHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubRequest', ], 'output' => [ 'shape' => 'DescribeHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHubContent' => [ 'name' => 'DescribeHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubContentRequest', ], 'output' => [ 'shape' => 'DescribeHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHumanTaskUi' => [ 'name' => 'DescribeHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DescribeHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHyperParameterTuningJob' => [ 'name' => 'DescribeHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'DescribeHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImage' => [ 'name' => 'DescribeImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageRequest', ], 'output' => [ 'shape' => 'DescribeImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImageVersion' => [ 'name' => 'DescribeImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageVersionRequest', ], 'output' => [ 'shape' => 'DescribeImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceExperiment' => [ 'name' => 'DescribeInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DescribeInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceRecommendationsJob' => [ 'name' => 'DescribeInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'DescribeInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLabelingJob' => [ 'name' => 'DescribeLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLabelingJobRequest', ], 'output' => [ 'shape' => 'DescribeLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLineageGroup' => [ 'name' => 'DescribeLineageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLineageGroupRequest', ], 'output' => [ 'shape' => 'DescribeLineageGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModel' => [ 'name' => 'DescribeModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelInput', ], 'output' => [ 'shape' => 'DescribeModelOutput', ], ], 'DescribeModelBiasJobDefinition' => [ 'name' => 'DescribeModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCard' => [ 'name' => 'DescribeModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardRequest', ], 'output' => [ 'shape' => 'DescribeModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCardExportJob' => [ 'name' => 'DescribeModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardExportJobRequest', ], 'output' => [ 'shape' => 'DescribeModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelExplainabilityJobDefinition' => [ 'name' => 'DescribeModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelPackage' => [ 'name' => 'DescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageInput', ], 'output' => [ 'shape' => 'DescribeModelPackageOutput', ], ], 'DescribeModelPackageGroup' => [ 'name' => 'DescribeModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageGroupInput', ], 'output' => [ 'shape' => 'DescribeModelPackageGroupOutput', ], ], 'DescribeModelQualityJobDefinition' => [ 'name' => 'DescribeModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeMonitoringSchedule' => [ 'name' => 'DescribeMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'DescribeMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeNotebookInstance' => [ 'name' => 'DescribeNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceOutput', ], ], 'DescribeNotebookInstanceLifecycleConfig' => [ 'name' => 'DescribeNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigOutput', ], ], 'DescribePipeline' => [ 'name' => 'DescribePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineRequest', ], 'output' => [ 'shape' => 'DescribePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineDefinitionForExecution' => [ 'name' => 'DescribePipelineDefinitionForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineDefinitionForExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineDefinitionForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineExecution' => [ 'name' => 'DescribePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProcessingJob' => [ 'name' => 'DescribeProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProcessingJobRequest', ], 'output' => [ 'shape' => 'DescribeProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProject' => [ 'name' => 'DescribeProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProjectInput', ], 'output' => [ 'shape' => 'DescribeProjectOutput', ], ], 'DescribeSpace' => [ 'name' => 'DescribeSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSpaceRequest', ], 'output' => [ 'shape' => 'DescribeSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeStudioLifecycleConfig' => [ 'name' => 'DescribeStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'DescribeStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeSubscribedWorkteam' => [ 'name' => 'DescribeSubscribedWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSubscribedWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeSubscribedWorkteamResponse', ], ], 'DescribeTrainingJob' => [ 'name' => 'DescribeTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrainingJobRequest', ], 'output' => [ 'shape' => 'DescribeTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTransformJob' => [ 'name' => 'DescribeTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTransformJobRequest', ], 'output' => [ 'shape' => 'DescribeTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrial' => [ 'name' => 'DescribeTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialRequest', ], 'output' => [ 'shape' => 'DescribeTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrialComponent' => [ 'name' => 'DescribeTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialComponentRequest', ], 'output' => [ 'shape' => 'DescribeTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeUserProfile' => [ 'name' => 'DescribeUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserProfileRequest', ], 'output' => [ 'shape' => 'DescribeUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeWorkforce' => [ 'name' => 'DescribeWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkforceRequest', ], 'output' => [ 'shape' => 'DescribeWorkforceResponse', ], ], 'DescribeWorkteam' => [ 'name' => 'DescribeWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeWorkteamResponse', ], ], 'DisableSagemakerServicecatalogPortfolio' => [ 'name' => 'DisableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioOutput', ], ], 'DisassociateTrialComponent' => [ 'name' => 'DisassociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateTrialComponentRequest', ], 'output' => [ 'shape' => 'DisassociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'EnableSagemakerServicecatalogPortfolio' => [ 'name' => 'EnableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioOutput', ], ], 'GetDeviceFleetReport' => [ 'name' => 'GetDeviceFleetReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceFleetReportRequest', ], 'output' => [ 'shape' => 'GetDeviceFleetReportResponse', ], ], 'GetLineageGroupPolicy' => [ 'name' => 'GetLineageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLineageGroupPolicyRequest', ], 'output' => [ 'shape' => 'GetLineageGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetModelPackageGroupPolicy' => [ 'name' => 'GetModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'GetModelPackageGroupPolicyOutput', ], ], 'GetSagemakerServicecatalogPortfolioStatus' => [ 'name' => 'GetSagemakerServicecatalogPortfolioStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusInput', ], 'output' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusOutput', ], ], 'GetScalingConfigurationRecommendation' => [ 'name' => 'GetScalingConfigurationRecommendation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetScalingConfigurationRecommendationRequest', ], 'output' => [ 'shape' => 'GetScalingConfigurationRecommendationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetSearchSuggestions' => [ 'name' => 'GetSearchSuggestions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSearchSuggestionsRequest', ], 'output' => [ 'shape' => 'GetSearchSuggestionsResponse', ], ], 'ImportHubContent' => [ 'name' => 'ImportHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportHubContentRequest', ], 'output' => [ 'shape' => 'ImportHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'ListActions' => [ 'name' => 'ListActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListActionsRequest', ], 'output' => [ 'shape' => 'ListActionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAlgorithms' => [ 'name' => 'ListAlgorithms', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAlgorithmsInput', ], 'output' => [ 'shape' => 'ListAlgorithmsOutput', ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesRequest', ], 'output' => [ 'shape' => 'ListAliasesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAppImageConfigs' => [ 'name' => 'ListAppImageConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppImageConfigsRequest', ], 'output' => [ 'shape' => 'ListAppImageConfigsResponse', ], ], 'ListApps' => [ 'name' => 'ListApps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppsRequest', ], 'output' => [ 'shape' => 'ListAppsResponse', ], ], 'ListArtifacts' => [ 'name' => 'ListArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListArtifactsRequest', ], 'output' => [ 'shape' => 'ListArtifactsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAssociations' => [ 'name' => 'ListAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAssociationsRequest', ], 'output' => [ 'shape' => 'ListAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAutoMLJobs' => [ 'name' => 'ListAutoMLJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAutoMLJobsRequest', ], 'output' => [ 'shape' => 'ListAutoMLJobsResponse', ], ], 'ListCandidatesForAutoMLJob' => [ 'name' => 'ListCandidatesForAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCandidatesForAutoMLJobRequest', ], 'output' => [ 'shape' => 'ListCandidatesForAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListCodeRepositories' => [ 'name' => 'ListCodeRepositories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCodeRepositoriesInput', ], 'output' => [ 'shape' => 'ListCodeRepositoriesOutput', ], ], 'ListCompilationJobs' => [ 'name' => 'ListCompilationJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCompilationJobsRequest', ], 'output' => [ 'shape' => 'ListCompilationJobsResponse', ], ], 'ListContexts' => [ 'name' => 'ListContexts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContextsRequest', ], 'output' => [ 'shape' => 'ListContextsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListDataQualityJobDefinitions' => [ 'name' => 'ListDataQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDataQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListDataQualityJobDefinitionsResponse', ], ], 'ListDeviceFleets' => [ 'name' => 'ListDeviceFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDeviceFleetsRequest', ], 'output' => [ 'shape' => 'ListDeviceFleetsResponse', ], ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResponse', ], ], 'ListDomains' => [ 'name' => 'ListDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDomainsRequest', ], 'output' => [ 'shape' => 'ListDomainsResponse', ], ], 'ListEdgeDeploymentPlans' => [ 'name' => 'ListEdgeDeploymentPlans', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgeDeploymentPlansRequest', ], 'output' => [ 'shape' => 'ListEdgeDeploymentPlansResponse', ], ], 'ListEdgePackagingJobs' => [ 'name' => 'ListEdgePackagingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgePackagingJobsRequest', ], 'output' => [ 'shape' => 'ListEdgePackagingJobsResponse', ], ], 'ListEndpointConfigs' => [ 'name' => 'ListEndpointConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointConfigsInput', ], 'output' => [ 'shape' => 'ListEndpointConfigsOutput', ], ], 'ListEndpoints' => [ 'name' => 'ListEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointsInput', ], 'output' => [ 'shape' => 'ListEndpointsOutput', ], ], 'ListExperiments' => [ 'name' => 'ListExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListExperimentsRequest', ], 'output' => [ 'shape' => 'ListExperimentsResponse', ], ], 'ListFeatureGroups' => [ 'name' => 'ListFeatureGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFeatureGroupsRequest', ], 'output' => [ 'shape' => 'ListFeatureGroupsResponse', ], ], 'ListFlowDefinitions' => [ 'name' => 'ListFlowDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFlowDefinitionsRequest', ], 'output' => [ 'shape' => 'ListFlowDefinitionsResponse', ], ], 'ListHubContentVersions' => [ 'name' => 'ListHubContentVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentVersionsRequest', ], 'output' => [ 'shape' => 'ListHubContentVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubContents' => [ 'name' => 'ListHubContents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentsRequest', ], 'output' => [ 'shape' => 'ListHubContentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubs' => [ 'name' => 'ListHubs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubsRequest', ], 'output' => [ 'shape' => 'ListHubsResponse', ], ], 'ListHumanTaskUis' => [ 'name' => 'ListHumanTaskUis', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHumanTaskUisRequest', ], 'output' => [ 'shape' => 'ListHumanTaskUisResponse', ], ], 'ListHyperParameterTuningJobs' => [ 'name' => 'ListHyperParameterTuningJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHyperParameterTuningJobsRequest', ], 'output' => [ 'shape' => 'ListHyperParameterTuningJobsResponse', ], ], 'ListImageVersions' => [ 'name' => 'ListImageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImageVersionsRequest', ], 'output' => [ 'shape' => 'ListImageVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListImages' => [ 'name' => 'ListImages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImagesRequest', ], 'output' => [ 'shape' => 'ListImagesResponse', ], ], 'ListInferenceExperiments' => [ 'name' => 'ListInferenceExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceExperimentsRequest', ], 'output' => [ 'shape' => 'ListInferenceExperimentsResponse', ], ], 'ListInferenceRecommendationsJobSteps' => [ 'name' => 'ListInferenceRecommendationsJobSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobStepsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListInferenceRecommendationsJobs' => [ 'name' => 'ListInferenceRecommendationsJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobsResponse', ], ], 'ListLabelingJobs' => [ 'name' => 'ListLabelingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsResponse', ], ], 'ListLabelingJobsForWorkteam' => [ 'name' => 'ListLabelingJobsForWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsForWorkteamRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsForWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListLineageGroups' => [ 'name' => 'ListLineageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLineageGroupsRequest', ], 'output' => [ 'shape' => 'ListLineageGroupsResponse', ], ], 'ListModelBiasJobDefinitions' => [ 'name' => 'ListModelBiasJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelBiasJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelBiasJobDefinitionsResponse', ], ], 'ListModelCardExportJobs' => [ 'name' => 'ListModelCardExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardExportJobsRequest', ], 'output' => [ 'shape' => 'ListModelCardExportJobsResponse', ], ], 'ListModelCardVersions' => [ 'name' => 'ListModelCardVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardVersionsRequest', ], 'output' => [ 'shape' => 'ListModelCardVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListModelCards' => [ 'name' => 'ListModelCards', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardsRequest', ], 'output' => [ 'shape' => 'ListModelCardsResponse', ], ], 'ListModelExplainabilityJobDefinitions' => [ 'name' => 'ListModelExplainabilityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsResponse', ], ], 'ListModelMetadata' => [ 'name' => 'ListModelMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelMetadataRequest', ], 'output' => [ 'shape' => 'ListModelMetadataResponse', ], ], 'ListModelPackageGroups' => [ 'name' => 'ListModelPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackageGroupsInput', ], 'output' => [ 'shape' => 'ListModelPackageGroupsOutput', ], ], 'ListModelPackages' => [ 'name' => 'ListModelPackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackagesInput', ], 'output' => [ 'shape' => 'ListModelPackagesOutput', ], ], 'ListModelQualityJobDefinitions' => [ 'name' => 'ListModelQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelQualityJobDefinitionsResponse', ], ], 'ListModels' => [ 'name' => 'ListModels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelsInput', ], 'output' => [ 'shape' => 'ListModelsOutput', ], ], 'ListMonitoringAlertHistory' => [ 'name' => 'ListMonitoringAlertHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertHistoryRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertHistoryResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringAlerts' => [ 'name' => 'ListMonitoringAlerts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertsRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringExecutions' => [ 'name' => 'ListMonitoringExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringExecutionsRequest', ], 'output' => [ 'shape' => 'ListMonitoringExecutionsResponse', ], ], 'ListMonitoringSchedules' => [ 'name' => 'ListMonitoringSchedules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringSchedulesRequest', ], 'output' => [ 'shape' => 'ListMonitoringSchedulesResponse', ], ], 'ListNotebookInstanceLifecycleConfigs' => [ 'name' => 'ListNotebookInstanceLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsInput', ], 'output' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsOutput', ], ], 'ListNotebookInstances' => [ 'name' => 'ListNotebookInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstancesInput', ], 'output' => [ 'shape' => 'ListNotebookInstancesOutput', ], ], 'ListPipelineExecutionSteps' => [ 'name' => 'ListPipelineExecutionSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionStepsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineExecutions' => [ 'name' => 'ListPipelineExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineParametersForExecution' => [ 'name' => 'ListPipelineParametersForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineParametersForExecutionRequest', ], 'output' => [ 'shape' => 'ListPipelineParametersForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelines' => [ 'name' => 'ListPipelines', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelinesRequest', ], 'output' => [ 'shape' => 'ListPipelinesResponse', ], ], 'ListProcessingJobs' => [ 'name' => 'ListProcessingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProcessingJobsRequest', ], 'output' => [ 'shape' => 'ListProcessingJobsResponse', ], ], 'ListProjects' => [ 'name' => 'ListProjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProjectsInput', ], 'output' => [ 'shape' => 'ListProjectsOutput', ], ], 'ListResourceCatalogs' => [ 'name' => 'ListResourceCatalogs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceCatalogsRequest', ], 'output' => [ 'shape' => 'ListResourceCatalogsResponse', ], ], 'ListSpaces' => [ 'name' => 'ListSpaces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSpacesRequest', ], 'output' => [ 'shape' => 'ListSpacesResponse', ], ], 'ListStageDevices' => [ 'name' => 'ListStageDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStageDevicesRequest', ], 'output' => [ 'shape' => 'ListStageDevicesResponse', ], ], 'ListStudioLifecycleConfigs' => [ 'name' => 'ListStudioLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudioLifecycleConfigsRequest', ], 'output' => [ 'shape' => 'ListStudioLifecycleConfigsResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'ListSubscribedWorkteams' => [ 'name' => 'ListSubscribedWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSubscribedWorkteamsRequest', ], 'output' => [ 'shape' => 'ListSubscribedWorkteamsResponse', ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsInput', ], 'output' => [ 'shape' => 'ListTagsOutput', ], ], 'ListTrainingJobs' => [ 'name' => 'ListTrainingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsResponse', ], ], 'ListTrainingJobsForHyperParameterTuningJob' => [ 'name' => 'ListTrainingJobsForHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTransformJobs' => [ 'name' => 'ListTransformJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTransformJobsRequest', ], 'output' => [ 'shape' => 'ListTransformJobsResponse', ], ], 'ListTrialComponents' => [ 'name' => 'ListTrialComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialComponentsRequest', ], 'output' => [ 'shape' => 'ListTrialComponentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTrials' => [ 'name' => 'ListTrials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialsRequest', ], 'output' => [ 'shape' => 'ListTrialsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListUserProfiles' => [ 'name' => 'ListUserProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserProfilesRequest', ], 'output' => [ 'shape' => 'ListUserProfilesResponse', ], ], 'ListWorkforces' => [ 'name' => 'ListWorkforces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkforcesRequest', ], 'output' => [ 'shape' => 'ListWorkforcesResponse', ], ], 'ListWorkteams' => [ 'name' => 'ListWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkteamsRequest', ], 'output' => [ 'shape' => 'ListWorkteamsResponse', ], ], 'PutModelPackageGroupPolicy' => [ 'name' => 'PutModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'PutModelPackageGroupPolicyOutput', ], ], 'QueryLineage' => [ 'name' => 'QueryLineage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'QueryLineageRequest', ], 'output' => [ 'shape' => 'QueryLineageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RegisterDevices' => [ 'name' => 'RegisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterDevicesRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'RenderUiTemplate' => [ 'name' => 'RenderUiTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RenderUiTemplateRequest', ], 'output' => [ 'shape' => 'RenderUiTemplateResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RetryPipelineExecution' => [ 'name' => 'RetryPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RetryPipelineExecutionRequest', ], 'output' => [ 'shape' => 'RetryPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'Search' => [ 'name' => 'Search', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchRequest', ], 'output' => [ 'shape' => 'SearchResponse', ], ], 'SendPipelineExecutionStepFailure' => [ 'name' => 'SendPipelineExecutionStepFailure', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepFailureRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepFailureResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'SendPipelineExecutionStepSuccess' => [ 'name' => 'SendPipelineExecutionStepSuccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepSuccessRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepSuccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StartEdgeDeploymentStage' => [ 'name' => 'StartEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartEdgeDeploymentStageRequest', ], ], 'StartInferenceExperiment' => [ 'name' => 'StartInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StartInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StartMonitoringSchedule' => [ 'name' => 'StartMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StartNotebookInstance' => [ 'name' => 'StartNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartNotebookInstanceInput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StartPipelineExecution' => [ 'name' => 'StartPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StartPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StopAutoMLJob' => [ 'name' => 'StopAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopAutoMLJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopCompilationJob' => [ 'name' => 'StopCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopEdgeDeploymentStage' => [ 'name' => 'StopEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgeDeploymentStageRequest', ], ], 'StopEdgePackagingJob' => [ 'name' => 'StopEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgePackagingJobRequest', ], ], 'StopHyperParameterTuningJob' => [ 'name' => 'StopHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopHyperParameterTuningJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceExperiment' => [ 'name' => 'StopInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StopInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceRecommendationsJob' => [ 'name' => 'StopInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceRecommendationsJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopLabelingJob' => [ 'name' => 'StopLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopLabelingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopMonitoringSchedule' => [ 'name' => 'StopMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopNotebookInstance' => [ 'name' => 'StopNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopNotebookInstanceInput', ], ], 'StopPipelineExecution' => [ 'name' => 'StopPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StopPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopProcessingJob' => [ 'name' => 'StopProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopProcessingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTrainingJob' => [ 'name' => 'StopTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTrainingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTransformJob' => [ 'name' => 'StopTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTransformJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAction' => [ 'name' => 'UpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateActionRequest', ], 'output' => [ 'shape' => 'UpdateActionResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAppImageConfig' => [ 'name' => 'UpdateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAppImageConfigRequest', ], 'output' => [ 'shape' => 'UpdateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateArtifact' => [ 'name' => 'UpdateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateArtifactRequest', ], 'output' => [ 'shape' => 'UpdateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateCodeRepository' => [ 'name' => 'UpdateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCodeRepositoryInput', ], 'output' => [ 'shape' => 'UpdateCodeRepositoryOutput', ], ], 'UpdateContext' => [ 'name' => 'UpdateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContextRequest', ], 'output' => [ 'shape' => 'UpdateContextResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateDeviceFleet' => [ 'name' => 'UpdateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'UpdateDevices' => [ 'name' => 'UpdateDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDevicesRequest', ], ], 'UpdateDomain' => [ 'name' => 'UpdateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainRequest', ], 'output' => [ 'shape' => 'UpdateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateEndpoint' => [ 'name' => 'UpdateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointInput', ], 'output' => [ 'shape' => 'UpdateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateEndpointWeightsAndCapacities' => [ 'name' => 'UpdateEndpointWeightsAndCapacities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesInput', ], 'output' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateExperiment' => [ 'name' => 'UpdateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateExperimentRequest', ], 'output' => [ 'shape' => 'UpdateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateFeatureGroup' => [ 'name' => 'UpdateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureGroupRequest', ], 'output' => [ 'shape' => 'UpdateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateFeatureMetadata' => [ 'name' => 'UpdateFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureMetadataRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateHub' => [ 'name' => 'UpdateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateHubRequest', ], 'output' => [ 'shape' => 'UpdateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImage' => [ 'name' => 'UpdateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageRequest', ], 'output' => [ 'shape' => 'UpdateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImageVersion' => [ 'name' => 'UpdateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageVersionRequest', ], 'output' => [ 'shape' => 'UpdateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateInferenceExperiment' => [ 'name' => 'UpdateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'UpdateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateModelCard' => [ 'name' => 'UpdateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelCardRequest', ], 'output' => [ 'shape' => 'UpdateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateModelPackage' => [ 'name' => 'UpdateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelPackageInput', ], 'output' => [ 'shape' => 'UpdateModelPackageOutput', ], ], 'UpdateMonitoringAlert' => [ 'name' => 'UpdateMonitoringAlert', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringAlertRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringAlertResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateMonitoringSchedule' => [ 'name' => 'UpdateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateNotebookInstance' => [ 'name' => 'UpdateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateNotebookInstanceLifecycleConfig' => [ 'name' => 'UpdateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdatePipeline' => [ 'name' => 'UpdatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineRequest', ], 'output' => [ 'shape' => 'UpdatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdatePipelineExecution' => [ 'name' => 'UpdatePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineExecutionRequest', ], 'output' => [ 'shape' => 'UpdatePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateProject' => [ 'name' => 'UpdateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProjectInput', ], 'output' => [ 'shape' => 'UpdateProjectOutput', ], ], 'UpdateSpace' => [ 'name' => 'UpdateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateSpaceRequest', ], 'output' => [ 'shape' => 'UpdateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrainingJob' => [ 'name' => 'UpdateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrainingJobRequest', ], 'output' => [ 'shape' => 'UpdateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrial' => [ 'name' => 'UpdateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialRequest', ], 'output' => [ 'shape' => 'UpdateTrialResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrialComponent' => [ 'name' => 'UpdateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialComponentRequest', ], 'output' => [ 'shape' => 'UpdateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateUserProfile' => [ 'name' => 'UpdateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserProfileRequest', ], 'output' => [ 'shape' => 'UpdateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateWorkforce' => [ 'name' => 'UpdateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkforceRequest', ], 'output' => [ 'shape' => 'UpdateWorkforceResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateWorkteam' => [ 'name' => 'UpdateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkteamRequest', ], 'output' => [ 'shape' => 'UpdateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], ], 'shapes' => [ 'Accept' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'AccountId' => [ 'type' => 'string', 'pattern' => '^\\d+$', ], 'ActionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*', ], 'ActionSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'String2048', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'Unknown', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionSummary', ], ], 'ActionSummary' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String64', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AddAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'AddAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'AddTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AddTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'max' => 3, ], 'AdditionalInferenceSpecificationDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Containers', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'AdditionalInferenceSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalInferenceSpecificationDefinition', ], 'max' => 15, 'min' => 1, ], 'AgentVersion' => [ 'type' => 'structure', 'required' => [ 'Version', 'AgentCount', ], 'members' => [ 'Version' => [ 'shape' => 'EdgeVersion', ], 'AgentCount' => [ 'shape' => 'Long', ], ], ], 'AgentVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentVersion', ], ], 'AggregationTransformationValue' => [ 'type' => 'string', 'enum' => [ 'sum', 'avg', 'first', 'min', 'max', ], ], 'AggregationTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'AggregationTransformationValue', ], 'max' => 50, 'min' => 1, ], 'Alarm' => [ 'type' => 'structure', 'members' => [ 'AlarmName' => [ 'shape' => 'AlarmName', ], ], ], 'AlarmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alarm', ], 'max' => 10, 'min' => 1, ], 'AlarmName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(?!\\s*$).+', ], 'AlgorithmArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:algorithm/.*', ], 'AlgorithmImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'AlgorithmSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'AlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'EnableSageMakerMetricsTimeSeries' => [ 'shape' => 'Boolean', ], 'ContainerEntrypoint' => [ 'shape' => 'TrainingContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'TrainingContainerArguments', ], 'TrainingImageConfig' => [ 'shape' => 'TrainingImageConfig', ], ], ], 'AlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'AlgorithmStatusDetails' => [ 'type' => 'structure', 'members' => [ 'ValidationStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], ], ], 'AlgorithmStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedAlgorithmStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'AlgorithmStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmStatusItem', ], ], 'AlgorithmSummary' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'AlgorithmStatus', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], ], ], 'AlgorithmSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmSummary', ], ], 'AlgorithmValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TrainingJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TrainingJobDefinition' => [ 'shape' => 'TrainingJobDefinition', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'AlgorithmValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmValidationProfile', ], 'max' => 1, 'min' => 1, ], 'AlgorithmValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'AlgorithmValidationProfiles', ], ], ], 'AnnotationConsolidationConfig' => [ 'type' => 'structure', 'required' => [ 'AnnotationConsolidationLambdaArn', ], 'members' => [ 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], ], ], 'AppArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*', ], 'AppDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'AppImageConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*', ], 'AppImageConfigDetails' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], ], ], 'AppImageConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppImageConfigDetails', ], ], 'AppImageConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppImageConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'AppInstanceType' => [ 'type' => 'string', 'enum' => [ 'system', 'ml.t3.micro', 'ml.t3.small', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.geospatial.interactive', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', ], ], 'AppList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppDetails', ], ], 'AppManaged' => [ 'type' => 'boolean', ], 'AppName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppNetworkAccessType' => [ 'type' => 'string', 'enum' => [ 'PublicInternetOnly', 'VpcOnly', ], ], 'AppSecurityGroupManagement' => [ 'type' => 'string', 'enum' => [ 'Service', 'Customer', ], ], 'AppSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'AppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'ContainerArguments', ], ], ], 'AppStatus' => [ 'type' => 'string', 'enum' => [ 'Deleted', 'Deleting', 'Failed', 'InService', 'Pending', ], ], 'AppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'TensorBoard', 'RStudioServerPro', 'RSessionGateway', ], ], 'ApprovalDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'ArnOrName' => [ 'type' => 'string', 'max' => 170, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:artifact/.*', ], 'ArtifactDigest' => [ 'type' => 'string', 'pattern' => '^[\\w:]+$', ], 'ArtifactSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'String2048', ], 'SourceTypes' => [ 'shape' => 'ArtifactSourceTypes', ], ], ], 'ArtifactSourceIdType' => [ 'type' => 'string', 'enum' => [ 'MD5Hash', 'S3ETag', 'S3Version', 'Custom', ], ], 'ArtifactSourceType' => [ 'type' => 'structure', 'required' => [ 'SourceIdType', 'Value', ], 'members' => [ 'SourceIdType' => [ 'shape' => 'ArtifactSourceIdType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ArtifactSourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSourceType', ], ], 'ArtifactSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSummary', ], ], 'ArtifactSummary' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AssemblyType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', ], ], 'AssociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'AssociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'AssociationEdgeType' => [ 'type' => 'string', 'enum' => [ 'ContributedTo', 'AssociatedWith', 'DerivedFrom', 'Produced', ], ], 'AssociationEntityArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*', ], 'AssociationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationSummary', ], ], 'AssociationSummary' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'SourceName' => [ 'shape' => 'ExperimentEntityName', ], 'DestinationName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'AsyncInferenceClientConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrentInvocationsPerInstance' => [ 'shape' => 'MaxConcurrentInvocationsPerInstance', ], ], ], 'AsyncInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'OutputConfig', ], 'members' => [ 'ClientConfig' => [ 'shape' => 'AsyncInferenceClientConfig', ], 'OutputConfig' => [ 'shape' => 'AsyncInferenceOutputConfig', ], ], ], 'AsyncInferenceNotificationConfig' => [ 'type' => 'structure', 'members' => [ 'SuccessTopic' => [ 'shape' => 'SnsTopicArn', ], 'ErrorTopic' => [ 'shape' => 'SnsTopicArn', ], 'IncludeInferenceResponseIn' => [ 'shape' => 'AsyncNotificationTopicTypeList', ], ], ], 'AsyncInferenceOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'DestinationS3Uri', ], 'NotificationConfig' => [ 'shape' => 'AsyncInferenceNotificationConfig', ], 'S3FailurePath' => [ 'shape' => 'DestinationS3Uri', ], ], ], 'AsyncNotificationTopicTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AsyncNotificationTopicTypes', ], 'max' => 2, 'min' => 0, ], 'AsyncNotificationTopicTypes' => [ 'type' => 'string', 'enum' => [ 'SUCCESS_NOTIFICATION_TOPIC', 'ERROR_NOTIFICATION_TOPIC', ], ], 'AthenaCatalog' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'AthenaDatabase' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'AthenaDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'Catalog', 'Database', 'QueryString', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'Catalog' => [ 'shape' => 'AthenaCatalog', ], 'Database' => [ 'shape' => 'AthenaDatabase', ], 'QueryString' => [ 'shape' => 'AthenaQueryString', ], 'WorkGroup' => [ 'shape' => 'AthenaWorkGroup', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'AthenaResultFormat', ], 'OutputCompression' => [ 'shape' => 'AthenaResultCompressionType', ], ], ], 'AthenaQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'AthenaResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'SNAPPY', 'ZLIB', ], ], 'AthenaResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'ORC', 'AVRO', 'JSON', 'TEXTFILE', ], ], 'AthenaWorkGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9._-]+', ], 'AttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.+', ], 'AttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeName', ], 'max' => 16, ], 'AuthMode' => [ 'type' => 'string', 'enum' => [ 'SSO', 'IAM', ], ], 'AutoGenerateEndpointName' => [ 'type' => 'boolean', ], 'AutoMLAlgorithm' => [ 'type' => 'string', 'enum' => [ 'xgboost', 'linear-learner', 'mlp', 'lightgbm', 'catboost', 'randomforest', 'extra-trees', 'nn-torch', 'fastai', ], ], 'AutoMLAlgorithmConfig' => [ 'type' => 'structure', 'required' => [ 'AutoMLAlgorithms', ], 'members' => [ 'AutoMLAlgorithms' => [ 'shape' => 'AutoMLAlgorithms', ], ], ], 'AutoMLAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithm', ], 'max' => 11, ], 'AutoMLAlgorithmsConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithmConfig', ], 'max' => 1, ], 'AutoMLCandidate' => [ 'type' => 'structure', 'required' => [ 'CandidateName', 'ObjectiveStatus', 'CandidateSteps', 'CandidateStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CandidateName' => [ 'shape' => 'CandidateName', ], 'FinalAutoMLJobObjectiveMetric' => [ 'shape' => 'FinalAutoMLJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], 'CandidateSteps' => [ 'shape' => 'CandidateSteps', ], 'CandidateStatus' => [ 'shape' => 'CandidateStatus', ], 'InferenceContainers' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'CandidateProperties' => [ 'shape' => 'CandidateProperties', ], 'InferenceContainerDefinitions' => [ 'shape' => 'AutoMLInferenceContainerDefinitions', ], ], ], 'AutoMLCandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'AutoMLCandidateStep' => [ 'type' => 'structure', 'required' => [ 'CandidateStepType', 'CandidateStepArn', 'CandidateStepName', ], 'members' => [ 'CandidateStepType' => [ 'shape' => 'CandidateStepType', ], 'CandidateStepArn' => [ 'shape' => 'CandidateStepArn', ], 'CandidateStepName' => [ 'shape' => 'CandidateStepName', ], ], ], 'AutoMLCandidates' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidate', ], ], 'AutoMLChannel' => [ 'type' => 'structure', 'required' => [ 'DataSource', 'TargetAttributeName', ], 'members' => [ 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'AutoMLChannelType' => [ 'type' => 'string', 'enum' => [ 'training', 'validation', ], ], 'AutoMLContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', 'ModelDataUrl', ], 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'AutoMLContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLContainerDefinition', ], 'max' => 5, ], 'AutoMLDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'AutoMLS3DataSource', ], ], ], 'AutoMLDataSplitConfig' => [ 'type' => 'structure', 'members' => [ 'ValidationFraction' => [ 'shape' => 'ValidationFraction', ], ], ], 'AutoMLFailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'AutoMLInferenceContainerDefinitions' => [ 'type' => 'map', 'key' => [ 'shape' => 'AutoMLProcessingUnit', ], 'value' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'max' => 2, ], 'AutoMLInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:automl-job/.*', ], 'AutoMLJobArtifacts' => [ 'type' => 'structure', 'members' => [ 'CandidateDefinitionNotebookLocation' => [ 'shape' => 'CandidateDefinitionNotebookLocation', ], 'DataExplorationNotebookLocation' => [ 'shape' => 'DataExplorationNotebookLocation', ], ], ], 'AutoMLJobChannel' => [ 'type' => 'structure', 'members' => [ 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], ], ], 'AutoMLJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'MaxCandidates' => [ 'shape' => 'MaxCandidates', ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'shape' => 'MaxRuntimePerTrainingJobInSeconds', ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'shape' => 'MaxAutoMLJobRuntimeInSeconds', ], ], ], 'AutoMLJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'CandidateGenerationConfig' => [ 'shape' => 'AutoMLCandidateGenerationConfig', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], ], ], 'AutoMLJobInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'AutoMLJobObjective' => [ 'type' => 'structure', 'required' => [ 'MetricName', ], 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'AutoMLJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'AutoMLJobSecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'AnalyzingData', 'FeatureEngineering', 'ModelTuning', 'MaxCandidatesReached', 'Failed', 'Stopped', 'MaxAutoMLJobRuntimeReached', 'Stopping', 'CandidateDefinitionsGenerated', 'GeneratingExplainabilityReport', 'Completed', 'ExplainabilityError', 'DeployingModel', 'ModelDeploymentError', 'GeneratingModelInsightsReport', 'ModelInsightsError', 'TrainingModels', 'PreTraining', ], ], 'AutoMLJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'AutoMLJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'AutoMLJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobSummary', ], ], 'AutoMLJobSummary' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], ], ], 'AutoMLMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'AutoMLMetricEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'MAE', 'R2', 'BalancedAccuracy', 'Precision', 'PrecisionMacro', 'Recall', 'RecallMacro', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', ], ], 'AutoMLMetricExtendedEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'MAE', 'R2', 'BalancedAccuracy', 'Precision', 'PrecisionMacro', 'Recall', 'RecallMacro', 'LogLoss', 'InferenceLatency', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', ], ], 'AutoMLMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'ENSEMBLING', 'HYPERPARAMETER_TUNING', ], ], 'AutoMLNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'AutoMLOutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLPartialFailureReason' => [ 'type' => 'structure', 'members' => [ 'PartialFailureMessage' => [ 'shape' => 'AutoMLFailureReason', ], ], ], 'AutoMLPartialFailureReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLPartialFailureReason', ], 'max' => 5, 'min' => 1, ], 'AutoMLProblemTypeConfig' => [ 'type' => 'structure', 'members' => [ 'ImageClassificationJobConfig' => [ 'shape' => 'ImageClassificationJobConfig', ], 'TextClassificationJobConfig' => [ 'shape' => 'TextClassificationJobConfig', ], 'TabularJobConfig' => [ 'shape' => 'TabularJobConfig', ], 'TimeSeriesForecastingJobConfig' => [ 'shape' => 'TimeSeriesForecastingJobConfig', ], ], 'union' => true, ], 'AutoMLProblemTypeConfigName' => [ 'type' => 'string', 'enum' => [ 'ImageClassification', 'TextClassification', 'Tabular', 'TimeSeriesForecasting', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'TabularResolvedAttributes' => [ 'shape' => 'TabularResolvedAttributes', ], ], 'union' => true, ], 'AutoMLProcessingUnit' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'AutoMLResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'AutoMLProblemTypeResolvedAttributes' => [ 'shape' => 'AutoMLProblemTypeResolvedAttributes', ], ], ], 'AutoMLS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AutoMLS3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'AutoMLSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'AutoMLSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'AutoMLSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'AutoParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'ValueHint', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'ValueHint' => [ 'shape' => 'ParameterValue', ], ], ], 'AutoParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoParameter', ], 'max' => 100, 'min' => 0, ], 'AutoRollbackConfig' => [ 'type' => 'structure', 'members' => [ 'Alarms' => [ 'shape' => 'AlarmList', ], ], ], 'Autotune' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'AutotuneMode', ], ], ], 'AutotuneMode' => [ 'type' => 'string', 'enum' => [ 'Enabled', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'type' => 'string', 'enum' => [ 'AWS/Rekognition/DetectModerationLabels/Image/V3', 'AWS/Textract/AnalyzeDocument/Forms/V1', ], ], 'BacktestResultsLocation' => [ 'type' => 'string', 'min' => 1, ], 'BatchDataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'GenerateInferenceId' => [ 'shape' => 'Boolean', ], ], ], 'BatchDescribeModelPackageError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', 'ErrorResponse', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorResponse' => [ 'shape' => 'String', ], ], ], 'BatchDescribeModelPackageErrorMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageError', ], ], 'BatchDescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArnList', ], 'members' => [ 'ModelPackageArnList' => [ 'shape' => 'ModelPackageArnList', ], ], ], 'BatchDescribeModelPackageOutput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageSummaries' => [ 'shape' => 'ModelPackageSummaries', ], 'BatchDescribeModelPackageErrorMap' => [ 'shape' => 'BatchDescribeModelPackageErrorMap', ], ], ], 'BatchDescribeModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageArn', 'CreationTime', 'InferenceSpecification', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'BatchStrategy' => [ 'type' => 'string', 'enum' => [ 'MultiRecord', 'SingleRecord', ], ], 'BatchTransformInput' => [ 'type' => 'structure', 'required' => [ 'DataCapturedDestinationS3Uri', 'DatasetFormat', 'LocalPath', ], 'members' => [ 'DataCapturedDestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'DatasetFormat' => [ 'shape' => 'MonitoringDatasetFormat', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], ], ], 'BestObjectiveNotImproving' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTrainingJobsNotImproving' => [ 'shape' => 'MaxNumberOfTrainingJobsNotImproving', ], ], ], 'Bias' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], 'PreTrainingReport' => [ 'shape' => 'MetricsSource', ], 'PostTrainingReport' => [ 'shape' => 'MetricsSource', ], ], ], 'BillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'BlockedReason' => [ 'type' => 'string', 'max' => 1024, ], 'BlueGreenUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'TrafficRoutingConfiguration', ], 'members' => [ 'TrafficRoutingConfiguration' => [ 'shape' => 'TrafficRoutingConfig', ], 'TerminationWaitInSeconds' => [ 'shape' => 'TerminationWaitInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOperator' => [ 'type' => 'string', 'enum' => [ 'And', 'Or', ], ], 'Branch' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[^ ~^:?*\\[]+', ], 'BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]', ], 'CacheHitResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'CallbackStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'SqsQueueUrl' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'CallbackToken' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^[a-zA-Z0-9]+$', ], 'CandidateArtifactLocations' => [ 'type' => 'structure', 'required' => [ 'Explainability', ], 'members' => [ 'Explainability' => [ 'shape' => 'ExplainabilityLocation', ], 'ModelInsights' => [ 'shape' => 'ModelInsightsLocation', ], 'BacktestResults' => [ 'shape' => 'BacktestResultsLocation', ], ], ], 'CandidateDefinitionNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'CandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'CandidateName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateProperties' => [ 'type' => 'structure', 'members' => [ 'CandidateArtifactLocations' => [ 'shape' => 'CandidateArtifactLocations', ], 'CandidateMetrics' => [ 'shape' => 'MetricDataList', ], ], ], 'CandidateSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'CandidateStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'CandidateStepArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/.*', ], 'CandidateStepName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateStepType' => [ 'type' => 'string', 'enum' => [ 'AWS::SageMaker::TrainingJob', 'AWS::SageMaker::TransformJob', 'AWS::SageMaker::ProcessingJob', ], ], 'CandidateSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidateStep', ], ], 'CanvasAppSettings' => [ 'type' => 'structure', 'members' => [ 'TimeSeriesForecastingSettings' => [ 'shape' => 'TimeSeriesForecastingSettings', ], 'ModelRegisterSettings' => [ 'shape' => 'ModelRegisterSettings', ], 'WorkspaceSettings' => [ 'shape' => 'WorkspaceSettings', ], ], ], 'CapacitySize' => [ 'type' => 'structure', 'required' => [ 'Type', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'CapacitySizeType', ], 'Value' => [ 'shape' => 'CapacitySizeValue', ], ], ], 'CapacitySizeType' => [ 'type' => 'string', 'enum' => [ 'INSTANCE_COUNT', 'CAPACITY_PERCENT', ], ], 'CapacitySizeValue' => [ 'type' => 'integer', 'min' => 1, ], 'CaptureContentTypeHeader' => [ 'type' => 'structure', 'members' => [ 'CsvContentTypes' => [ 'shape' => 'CsvContentTypes', ], 'JsonContentTypes' => [ 'shape' => 'JsonContentTypes', ], ], ], 'CaptureMode' => [ 'type' => 'string', 'enum' => [ 'Input', 'Output', ], ], 'CaptureOption' => [ 'type' => 'structure', 'required' => [ 'CaptureMode', ], 'members' => [ 'CaptureMode' => [ 'shape' => 'CaptureMode', ], ], ], 'CaptureOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptureOption', ], 'max' => 2, 'min' => 1, ], 'CaptureStatus' => [ 'type' => 'string', 'enum' => [ 'Started', 'Stopped', ], ], 'Catalog' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'CategoricalParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String64', ], 'Value' => [ 'shape' => 'CategoricalParameterRangeValues', ], ], ], 'CategoricalParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'Values', ], 'members' => [ 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String128', ], 'max' => 3, 'min' => 1, ], 'CategoricalParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameterRange', ], 'max' => 30, 'min' => 0, ], 'CategoricalParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameter', ], 'max' => 5, 'min' => 1, ], 'Cents' => [ 'type' => 'integer', 'max' => 99, 'min' => 0, ], 'CertifyForMarketplace' => [ 'type' => 'boolean', ], 'Channel' => [ 'type' => 'structure', 'required' => [ 'ChannelName', 'DataSource', ], 'members' => [ 'ChannelName' => [ 'shape' => 'ChannelName', ], 'DataSource' => [ 'shape' => 'DataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'RecordWrapperType' => [ 'shape' => 'RecordWrapper', ], 'InputMode' => [ 'shape' => 'TrainingInputMode', ], 'ShuffleConfig' => [ 'shape' => 'ShuffleConfig', ], ], ], 'ChannelName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9\\.\\-_]+', ], 'ChannelSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'SupportedContentTypes', 'SupportedInputModes', ], 'members' => [ 'Name' => [ 'shape' => 'ChannelName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedCompressionTypes' => [ 'shape' => 'CompressionTypes', ], 'SupportedInputModes' => [ 'shape' => 'InputModes', ], ], ], 'ChannelSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelSpecification', ], 'max' => 8, 'min' => 1, ], 'CheckpointConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'Cidr' => [ 'type' => 'string', 'max' => 64, 'min' => 4, 'pattern' => '(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)', ], 'Cidrs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cidr', ], ], 'ClarifyCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'ClarifyContentTemplate' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyEnableExplanations' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyExplainerConfig' => [ 'type' => 'structure', 'required' => [ 'ShapConfig', ], 'members' => [ 'EnableExplanations' => [ 'shape' => 'ClarifyEnableExplanations', ], 'InferenceConfig' => [ 'shape' => 'ClarifyInferenceConfig', ], 'ShapConfig' => [ 'shape' => 'ClarifyShapConfig', ], ], ], 'ClarifyFeatureHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeatureType' => [ 'type' => 'string', 'enum' => [ 'numerical', 'categorical', 'text', ], ], 'ClarifyFeatureTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyFeatureType', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeaturesAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyHeader' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyInferenceConfig' => [ 'type' => 'structure', 'members' => [ 'FeaturesAttribute' => [ 'shape' => 'ClarifyFeaturesAttribute', ], 'ContentTemplate' => [ 'shape' => 'ClarifyContentTemplate', ], 'MaxRecordCount' => [ 'shape' => 'ClarifyMaxRecordCount', ], 'MaxPayloadInMB' => [ 'shape' => 'ClarifyMaxPayloadInMB', ], 'ProbabilityIndex' => [ 'shape' => 'ClarifyProbabilityIndex', ], 'LabelIndex' => [ 'shape' => 'ClarifyLabelIndex', ], 'ProbabilityAttribute' => [ 'shape' => 'ClarifyProbabilityAttribute', ], 'LabelAttribute' => [ 'shape' => 'ClarifyLabelAttribute', ], 'LabelHeaders' => [ 'shape' => 'ClarifyLabelHeaders', ], 'FeatureHeaders' => [ 'shape' => 'ClarifyFeatureHeaders', ], 'FeatureTypes' => [ 'shape' => 'ClarifyFeatureTypes', ], ], ], 'ClarifyLabelAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyLabelHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 16, 'min' => 1, ], 'ClarifyLabelIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyMaxPayloadInMB' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'ClarifyMaxRecordCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyMimeType' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*', ], 'ClarifyProbabilityAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyProbabilityIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyShapBaseline' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'ClarifyShapBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'MimeType' => [ 'shape' => 'ClarifyMimeType', ], 'ShapBaseline' => [ 'shape' => 'ClarifyShapBaseline', ], 'ShapBaselineUri' => [ 'shape' => 'Url', ], ], ], 'ClarifyShapConfig' => [ 'type' => 'structure', 'required' => [ 'ShapBaselineConfig', ], 'members' => [ 'ShapBaselineConfig' => [ 'shape' => 'ClarifyShapBaselineConfig', ], 'NumberOfSamples' => [ 'shape' => 'ClarifyShapNumberOfSamples', ], 'UseLogit' => [ 'shape' => 'ClarifyShapUseLogit', ], 'Seed' => [ 'shape' => 'ClarifyShapSeed', ], 'TextConfig' => [ 'shape' => 'ClarifyTextConfig', ], ], ], 'ClarifyShapNumberOfSamples' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyShapSeed' => [ 'type' => 'integer', ], 'ClarifyShapUseLogit' => [ 'type' => 'boolean', ], 'ClarifyTextConfig' => [ 'type' => 'structure', 'required' => [ 'Language', 'Granularity', ], 'members' => [ 'Language' => [ 'shape' => 'ClarifyTextLanguage', ], 'Granularity' => [ 'shape' => 'ClarifyTextGranularity', ], ], ], 'ClarifyTextGranularity' => [ 'type' => 'string', 'enum' => [ 'token', 'sentence', 'paragraph', ], ], 'ClarifyTextLanguage' => [ 'type' => 'string', 'enum' => [ 'af', 'sq', 'ar', 'hy', 'eu', 'bn', 'bg', 'ca', 'zh', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fi', 'fr', 'de', 'el', 'gu', 'he', 'hi', 'hu', 'is', 'id', 'ga', 'it', 'kn', 'ky', 'lv', 'lt', 'lb', 'mk', 'ml', 'mr', 'ne', 'nb', 'fa', 'pl', 'pt', 'ro', 'ru', 'sa', 'sr', 'tn', 'si', 'sk', 'sl', 'es', 'sv', 'tl', 'ta', 'tt', 'te', 'tr', 'uk', 'ur', 'yo', 'lij', 'xx', ], ], 'ClientId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', ], 'ClientSecret' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', 'sensitive' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'CodeRepositories' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepository', ], 'max' => 10, ], 'CodeRepository' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'RepositoryUrl', ], ], ], 'CodeRepositoryArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:code-repository/.*', ], 'CodeRepositoryContains' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameOrUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'CodeRepositorySortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'CodeRepositorySortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'CodeRepositorySummary' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'CodeRepositorySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositorySummary', ], ], 'CognitoConfig' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoMemberDefinition' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'UserGroup', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'UserGroup' => [ 'shape' => 'CognitoUserGroup', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoUserGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'CognitoUserPool' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'CollectionConfiguration' => [ 'type' => 'structure', 'members' => [ 'CollectionName' => [ 'shape' => 'CollectionName', ], 'CollectionParameters' => [ 'shape' => 'CollectionParameters', ], ], ], 'CollectionConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'CollectionConfiguration', ], 'max' => 20, 'min' => 0, ], 'CollectionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'CollectionParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'CompilationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*', ], 'CompilationJobStatus' => [ 'type' => 'string', 'enum' => [ 'INPROGRESS', 'COMPLETED', 'FAILED', 'STARTING', 'STOPPING', 'STOPPED', ], ], 'CompilationJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompilationJobSummary', ], ], 'CompilationJobSummary' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CreationTime', 'CompilationJobStatus', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'CompilationTargetDevice' => [ 'shape' => 'TargetDevice', ], 'CompilationTargetPlatformOs' => [ 'shape' => 'TargetPlatformOs', ], 'CompilationTargetPlatformArch' => [ 'shape' => 'TargetPlatformArch', ], 'CompilationTargetPlatformAccelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], ], ], 'CompilerOptions' => [ 'type' => 'string', 'max' => 1024, 'min' => 3, 'pattern' => '.*', ], 'CompleteOnConvergence' => [ 'type' => 'string', 'enum' => [ 'Disabled', 'Enabled', ], ], 'CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'CompressionTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompressionType', ], ], 'ConditionOutcome' => [ 'type' => 'string', 'enum' => [ 'True', 'False', ], ], 'ConditionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Outcome' => [ 'shape' => 'ConditionOutcome', ], ], ], 'ConfigKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'ConfigValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 100, 'min' => 1, ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageConfig' => [ 'shape' => 'ImageConfig', ], 'Mode' => [ 'shape' => 'ContainerMode', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'MultiModelConfig' => [ 'shape' => 'MultiModelConfig', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], ], ], 'ContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], 'max' => 15, ], 'ContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'ContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerHostname' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ContainerImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '[\\S]+', ], 'ContainerMode' => [ 'type' => 'string', 'enum' => [ 'SingleModel', 'MultiModel', ], ], 'ContentClassifier' => [ 'type' => 'string', 'enum' => [ 'FreeOfPersonallyIdentifiableInformation', 'FreeOfAdultContent', ], ], 'ContentClassifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentClassifier', ], 'max' => 256, ], 'ContentColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContentDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentType', ], ], 'ContextArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/.*', ], 'ContextSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'String2048', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ContextSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContextSummary', ], ], 'ContextSummary' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ContinuousParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'ContinuousParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'ContinuousParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousParameterRange', ], 'max' => 30, 'min' => 0, ], 'ConvergenceDetected' => [ 'type' => 'structure', 'members' => [ 'CompleteOnConvergence' => [ 'shape' => 'CompleteOnConvergence', ], ], ], 'CreateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', 'Source', 'ActionType', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'CreateAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'TrainingSpecification', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmArn', ], 'members' => [ 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], ], ], 'CreateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'Tags' => [ 'shape' => 'TagList', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], ], ], 'CreateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'CreateAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'CreateAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], ], ], 'CreateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'Source', 'ArtifactType', ], 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'CreateAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], ], ], 'CreateAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'AutoMLProblemTypeConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], ], ], 'CreateAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'GitConfig', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'CreateCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'RoleArn', 'OutputConfig', 'StoppingCondition', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobArn', ], 'members' => [ 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], ], ], 'CreateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', 'Source', 'ContextType', ], 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'CreateDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'AuthMode', 'DefaultUserSettings', 'SubnetIds', 'VpcId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'Tags' => [ 'shape' => 'TagList', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'CreateEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], ], ], 'CreateEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], ], ], 'CreateEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', 'CompilationJobName', 'ModelName', 'ModelVersion', 'RoleArn', 'OutputConfig', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'ProductionVariants', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], ], ], 'CreateEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigArn', ], 'members' => [ 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], ], ], 'CreateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'CreateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'CreateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'CreateFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'HumanLoopConfig', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], ], ], 'CreateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubDescription', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'CreateHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'UiTemplate', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'CreateHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobConfig', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'Autotune' => [ 'shape' => 'Autotune', ], ], ], 'CreateHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobArn', ], 'members' => [ 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'CreateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'RoleArn', ], 'members' => [ 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'CreateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'BaseImage', 'ClientToken', 'ImageName', ], 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ImageName' => [ 'shape' => 'ImageName', ], 'Aliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'CreateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'CreateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'RoleArn', 'EndpointName', 'ModelVariants', 'ShadowModeConfig', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'CreateInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'RoleArn', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'OutputConfig' => [ 'shape' => 'RecommendationJobOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobArn', ], 'members' => [ 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], ], ], 'CreateLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelAttributeName', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobArn', ], 'members' => [ 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], ], ], 'CreateModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardExportJobName', 'OutputConfig', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], ], ], 'CreateModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'CreateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'Content', 'ModelCardStatus', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ExecutionRoleArn', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelArn', ], 'members' => [ 'ModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'CreateModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'CreateModelPackageInput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], ], ], 'CreateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'CreateModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'CreateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'InstanceType', 'RoleArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], ], ], 'CreateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], ], ], 'CreatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', 'RoleArn', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'CreatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'CreatePresignedDomainUrlRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], 'ExpiresInSeconds' => [ 'shape' => 'ExpiresInSeconds', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'CreatePresignedDomainUrlResponse' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'PresignedDomainUrl', ], ], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], ], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'NotebookInstanceUrl', ], ], ], 'CreateProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'RoleArn', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobArn', ], 'members' => [ 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'CreateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ServiceCatalogProvisioningDetails', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectId', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], ], ], 'CreateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], ], ], 'CreateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'CreateStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', 'StudioLifecycleConfigContent', 'StudioLifecycleConfigAppType', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'CreateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], ], ], 'CreateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'CreateTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'ModelName', 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobArn', ], 'members' => [ 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], ], ], 'CreateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'CreateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', 'ExperimentName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'CreateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'Tags' => [ 'shape' => 'TagList', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'CreateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'CreateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'CreateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'WorkforceArn', ], 'members' => [ 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], ], ], 'CreateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateWorkteamResponse' => [ 'type' => 'structure', 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'CreationTime' => [ 'type' => 'timestamp', ], 'CrossAccountFilterOption' => [ 'type' => 'string', 'enum' => [ 'SameAccount', 'CrossAccount', ], ], 'CsvContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'CsvContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CsvContentType', ], 'max' => 10, 'min' => 1, ], 'CustomImage' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'AppImageConfigName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageVersionNumber' => [ 'shape' => 'ImageVersionNumber', 'box' => true, ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'CustomImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomImage', ], 'max' => 200, ], 'CustomerMetadataKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}', ], 'CustomerMetadataKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerMetadataKey', ], ], 'CustomerMetadataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CustomerMetadataKey', ], 'value' => [ 'shape' => 'CustomerMetadataValue', ], 'max' => 50, 'min' => 1, ], 'CustomerMetadataValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}', ], 'CustomizedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'String', ], 'Namespace' => [ 'shape' => 'String', ], 'Statistic' => [ 'shape' => 'Statistic', ], ], ], 'DataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'InitialSamplingPercentage', 'DestinationS3Uri', 'CaptureOptions', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'InitialSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CaptureOptions' => [ 'shape' => 'CaptureOptionList', ], 'CaptureContentTypeHeader' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'DataCaptureConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EnableCapture', 'CaptureStatus', 'CurrentSamplingPercentage', 'DestinationS3Uri', 'KmsKeyId', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'CaptureStatus' => [ 'shape' => 'CaptureStatus', ], 'CurrentSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'DataCatalogConfig' => [ 'type' => 'structure', 'required' => [ 'TableName', 'Catalog', 'Database', ], 'members' => [ 'TableName' => [ 'shape' => 'TableName', ], 'Catalog' => [ 'shape' => 'Catalog', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'DataExplorationNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'DataInputConfig' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DataProcessing' => [ 'type' => 'structure', 'members' => [ 'InputFilter' => [ 'shape' => 'JsonPath', ], 'OutputFilter' => [ 'shape' => 'JsonPath', ], 'JoinSource' => [ 'shape' => 'JoinSource', ], ], ], 'DataQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'DataQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'DataQualityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3DataSource', ], 'FileSystemDataSource' => [ 'shape' => 'FileSystemDataSource', ], ], ], 'Database' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'DatasetDefinition' => [ 'type' => 'structure', 'members' => [ 'AthenaDatasetDefinition' => [ 'shape' => 'AthenaDatasetDefinition', ], 'RedshiftDatasetDefinition' => [ 'shape' => 'RedshiftDatasetDefinition', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'DataDistributionType' => [ 'shape' => 'DataDistributionType', ], 'InputMode' => [ 'shape' => 'InputMode', ], ], ], 'DebugHookConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'HookParameters' => [ 'shape' => 'HookParameters', ], 'CollectionConfigurations' => [ 'shape' => 'CollectionConfigurations', ], ], ], 'DebugRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'DebugRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'DebugRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DebugRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'DefaultGid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DefaultSpaceSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], ], ], 'DefaultUid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DeleteActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'DeleteAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DeleteAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DeleteArtifactRequest' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], ], ], 'DeleteArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DeleteAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'RetentionPolicy' => [ 'shape' => 'RetentionPolicy', ], ], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DeleteEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DeleteExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'DeleteFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'DeleteFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DeleteFlowDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', 'HubContentVersion', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DeleteHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DeleteHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DeleteHumanTaskUiResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DeleteImageResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DeleteImageVersionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DeleteInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DeleteModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DeleteModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DeleteNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DeletePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'DeletePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'DeleteProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DeleteSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DeleteStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DeleteTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'DeleteTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'DeleteTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DeleteUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DeleteWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DeleteWorkforceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DeleteWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Success', ], 'members' => [ 'Success' => [ 'shape' => 'Success', ], ], ], 'DependencyCopyPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DependencyOriginPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DeployedImage' => [ 'type' => 'structure', 'members' => [ 'SpecifiedImage' => [ 'shape' => 'ContainerImage', ], 'ResolvedImage' => [ 'shape' => 'ContainerImage', ], 'ResolutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeployedImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeployedImage', ], ], 'DeploymentConfig' => [ 'type' => 'structure', 'members' => [ 'BlueGreenUpdatePolicy' => [ 'shape' => 'BlueGreenUpdatePolicy', ], 'AutoRollbackConfiguration' => [ 'shape' => 'AutoRollbackConfig', ], 'RollingUpdatePolicy' => [ 'shape' => 'RollingUpdatePolicy', ], ], ], 'DeploymentRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationStatus', ], 'members' => [ 'RecommendationStatus' => [ 'shape' => 'RecommendationStatus', ], 'RealTimeInferenceRecommendations' => [ 'shape' => 'RealTimeInferenceRecommendations', ], ], ], 'DeploymentStage' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], ], ], 'DeploymentStageMaxResults' => [ 'type' => 'integer', 'max' => 10, ], 'DeploymentStageStatusSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStageStatusSummary', ], ], 'DeploymentStageStatusSummary' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', 'DeploymentConfig', 'DeploymentStatus', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], 'DeploymentStatus' => [ 'shape' => 'EdgeDeploymentStatus', ], ], ], 'DeploymentStages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStage', ], ], 'DeregisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceNames', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], ], ], 'DescribeActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ActionArn' => [ 'shape' => 'ActionArn', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'TrainingSpecification', 'AlgorithmStatus', 'AlgorithmStatusDetails', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], 'AlgorithmStatusDetails' => [ 'shape' => 'AlgorithmStatusDetails', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], ], ], 'DescribeAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DescribeAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], ], ], 'DescribeAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'LastHealthCheckTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUserActivityTimestamp' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DescribeArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'ResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], ], ], 'DescribeAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'AutoMLResolvedAttributes', ], 'AutoMLProblemTypeConfigName' => [ 'shape' => 'AutoMLProblemTypeConfigName', ], ], ], 'DescribeCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'DescribeCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CompilationJobStatus', 'StoppingCondition', 'CreationTime', 'LastModifiedTime', 'FailureReason', 'ModelArtifacts', 'RoleArn', 'InputConfig', 'OutputConfig', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'InferenceImage' => [ 'shape' => 'InferenceImage', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'ModelDigests' => [ 'shape' => 'ModelDigests', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], ], ], 'DescribeContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], 'ContextArn' => [ 'shape' => 'ContextArn', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceFleetResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceFleetArn', 'OutputConfig', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'IotRoleAlias' => [ 'shape' => 'IotRoleAlias', ], ], ], 'DescribeDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', 'RegistrationTime', ], 'members' => [ 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModels', ], 'MaxModels' => [ 'shape' => 'Integer', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'HomeEfsFileSystemId' => [ 'shape' => 'ResourceId', ], 'SingleSignOnManagedApplicationInstanceId' => [ 'shape' => 'String256', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'Url' => [ 'shape' => 'String1024', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'SecurityGroupIdForDomainBoundary' => [ 'shape' => 'SecurityGroupId', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'DeploymentStageMaxResults', ], ], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'Stages' => [ 'shape' => 'DeploymentStageStatusSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeEdgePackagingJobResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'EdgePackagingJobStatusMessage' => [ 'shape' => 'String', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ModelArtifact' => [ 'shape' => 'S3Uri', ], 'ModelSignature' => [ 'shape' => 'String', ], 'PresetDeploymentOutput' => [ 'shape' => 'EdgePresetDeploymentOutput', ], ], ], 'DescribeEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DescribeEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'ProductionVariants', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], ], ], 'DescribeEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DescribeEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointConfigName', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastDeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'PendingDeploymentSummary' => [ 'shape' => 'PendingDeploymentSummary', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'DescribeExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', 'CreationTime', 'NextToken', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'OnlineStoreTotalSizeBytes' => [ 'shape' => 'OnlineStoreTotalSizeBytes', ], ], ], 'DescribeFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], ], ], 'DescribeFeatureMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'FeatureName', 'FeatureType', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'DescribeFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DescribeFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', 'FlowDefinitionName', 'FlowDefinitionStatus', 'CreationTime', 'HumanLoopConfig', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DescribeHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DescribeHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubArn', 'HubContentDocument', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentDependencies' => [ 'shape' => 'HubContentDependencyList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DescribeHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DescribeHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', 'HumanTaskUiName', 'CreationTime', 'UiTemplate', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiStatus' => [ 'shape' => 'HumanTaskUiStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'UiTemplate' => [ 'shape' => 'UiTemplateInfo', ], ], ], 'DescribeHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'DescribeHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobConfig', 'HyperParameterTuningJobStatus', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], 'Autotune' => [ 'shape' => 'Autotune', ], ], ], 'DescribeImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DescribeImageResponse' => [ 'type' => 'structure', 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'DescribeImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DescribeImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ContainerImage' => [ 'shape' => 'ImageContainerImage', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'DescribeInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DescribeInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Name', 'Type', 'Status', 'EndpointMetadata', 'ModelVariants', ], 'members' => [ 'Arn' => [ 'shape' => 'InferenceExperimentArn', ], 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointMetadata' => [ 'shape' => 'EndpointMetadata', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigSummaryList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], ], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'JobArn', 'RoleArn', 'Status', 'CreationTime', 'LastModifiedTime', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'InferenceRecommendations' => [ 'shape' => 'InferenceRecommendations', ], 'EndpointPerformances' => [ 'shape' => 'EndpointPerformances', ], ], ], 'DescribeLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'DescribeLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobStatus', 'LabelCounters', 'CreationTime', 'LastModifiedTime', 'JobReferenceCode', 'LabelingJobName', 'LabelingJobArn', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], ], ], 'DescribeLineageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeLineageGroupResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'DescribeModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'OutputConfig', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExportArtifacts' => [ 'shape' => 'ModelCardExportArtifacts', ], ], ], 'DescribeModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], ], ], 'DescribeModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', 'ModelCardName', 'ModelCardVersion', 'Content', 'ModelCardStatus', 'CreationTime', 'CreatedBy', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ModelCardProcessingStatus' => [ 'shape' => 'ModelCardProcessingStatus', ], ], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DescribeModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ExecutionRoleArn', 'CreationTime', 'ModelArn', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'DescribeModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'CreatedBy', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'DescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DescribeModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', 'ModelPackageStatusDetails', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], ], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DescribeMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', 'MonitoringScheduleName', 'MonitoringScheduleStatus', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], ], ], 'DescribeNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], ], ], 'DescribeNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'NetworkInterfaceId' => [ 'shape' => 'NetworkInterfaceId', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'DescribePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], ], ], 'DescribePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'DescribeProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'DescribeProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'ProcessingJobArn', 'ProcessingJobStatus', 'CreationTime', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'DescribeProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DescribeProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectName', 'ProjectId', 'ServiceCatalogProvisioningDetails', 'ProjectStatus', 'CreationTime', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceArn' => [ 'shape' => 'SpaceArn', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], ], ], 'DescribeStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DescribeStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'DescribeSubscribedWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'DescribeSubscribedWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteam', ], 'members' => [ 'SubscribedWorkteam' => [ 'shape' => 'SubscribedWorkteam', ], ], ], 'DescribeTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'DescribeTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'ModelArtifacts', 'TrainingJobStatus', 'SecondaryStatus', 'AlgorithmSpecification', 'ResourceConfig', 'StoppingCondition', 'CreationTime', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ProfilerRuleEvaluationStatuses' => [ 'shape' => 'ProfilerRuleEvaluationStatuses', ], 'ProfilingStatus' => [ 'shape' => 'ProfilingStatus', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], ], ], 'DescribeTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'DescribeTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'TransformJobStatus', 'ModelName', 'TransformInput', 'TransformResources', 'CreationTime', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'DescribeTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Sources' => [ 'shape' => 'TrialComponentSources', ], ], ], 'DescribeTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], ], ], 'DescribeUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DescribeUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'DescribeWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DescribeWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'DescribeWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DescribeWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 128, ], 'DesiredWeightAndCapacity' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'ServerlessUpdateConfig' => [ 'shape' => 'ProductionVariantServerlessUpdateConfig', ], ], ], 'DesiredWeightAndCapacityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DesiredWeightAndCapacity', ], 'min' => 1, ], 'DestinationS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/])/?(.*)$', ], 'DetailedAlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'DetailedModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'DeviceName', ], 'members' => [ 'DeviceName' => [ 'shape' => 'DeviceName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'IotThingName' => [ 'shape' => 'ThingName', ], ], ], 'DeviceArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'READYTODEPLOY', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'DeviceDeploymentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceDeploymentSummary', ], ], 'DeviceDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'StageName', 'DeviceName', 'DeviceArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], 'DeployedStageName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceName' => [ 'shape' => 'DeviceName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceDeploymentStatus' => [ 'shape' => 'DeviceDeploymentStatus', ], 'DeviceDeploymentStatusMessage' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeploymentStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceDescription' => [ 'type' => 'string', 'max' => 40, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DeviceFleetArn' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceFleetDescription' => [ 'type' => 'string', 'max' => 800, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DeviceFleetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceFleetSummary', ], ], 'DeviceFleetSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'DeviceNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceName', ], ], 'DeviceSelectionConfig' => [ 'type' => 'structure', 'required' => [ 'DeviceSubsetType', ], 'members' => [ 'DeviceSubsetType' => [ 'shape' => 'DeviceSubsetType', ], 'Percentage' => [ 'shape' => 'Percentage', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], 'DeviceNameContains' => [ 'shape' => 'DeviceName', ], ], ], 'DeviceStats' => [ 'type' => 'structure', 'required' => [ 'ConnectedDeviceCount', 'RegisteredDeviceCount', ], 'members' => [ 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'RegisteredDeviceCount' => [ 'shape' => 'Long', ], ], ], 'DeviceSubsetType' => [ 'type' => 'string', 'enum' => [ 'PERCENTAGE', 'SELECTION', 'NAMECONTAINS', ], ], 'DeviceSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceSummary', ], ], 'DeviceSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceArn', ], 'members' => [ 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModelSummaries', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'Devices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'DirectInternetAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Direction' => [ 'type' => 'string', 'enum' => [ 'Both', 'Ascendants', 'Descendants', ], ], 'DirectoryPath' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'DisableProfiler' => [ 'type' => 'boolean', ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'type' => 'boolean', ], 'DisassociateDefaultCodeRepository' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'type' => 'boolean', ], 'DisassociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DisassociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DocumentSchemaVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'Dollars' => [ 'type' => 'integer', 'max' => 2, 'min' => 0, ], 'DomainArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*', ], 'DomainDetails' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DomainId' => [ 'type' => 'string', 'max' => 63, ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainDetails', ], ], 'DomainName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'DomainSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 3, ], 'DomainSettings' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'RStudioServerProDomainSettings' => [ 'shape' => 'RStudioServerProDomainSettings', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], ], ], 'DomainSettingsForUpdate' => [ 'type' => 'structure', 'members' => [ 'RStudioServerProDomainSettingsForUpdate' => [ 'shape' => 'RStudioServerProDomainSettingsForUpdate', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], ], ], 'DomainStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'Double' => [ 'type' => 'double', ], 'DoubleParameterValue' => [ 'type' => 'double', ], 'DriftCheckBaselines' => [ 'type' => 'structure', 'members' => [ 'Bias' => [ 'shape' => 'DriftCheckBias', ], 'Explainability' => [ 'shape' => 'DriftCheckExplainability', ], 'ModelQuality' => [ 'shape' => 'DriftCheckModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'DriftCheckModelDataQuality', ], ], ], 'DriftCheckBias' => [ 'type' => 'structure', 'members' => [ 'ConfigFile' => [ 'shape' => 'FileSource', ], 'PreTrainingConstraints' => [ 'shape' => 'MetricsSource', ], 'PostTrainingConstraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckExplainability' => [ 'type' => 'structure', 'members' => [ 'Constraints' => [ 'shape' => 'MetricsSource', ], 'ConfigFile' => [ 'shape' => 'FileSource', ], ], ], 'DriftCheckModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DynamicScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'Integer', ], 'MaxCapacity' => [ 'shape' => 'Integer', ], 'ScaleInCooldown' => [ 'shape' => 'Integer', ], 'ScaleOutCooldown' => [ 'shape' => 'Integer', ], 'ScalingPolicies' => [ 'shape' => 'ScalingPolicies', ], ], ], 'EMRStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'String256', ], 'StepId' => [ 'shape' => 'String256', ], 'StepName' => [ 'shape' => 'String256', ], 'LogFilePath' => [ 'shape' => 'String1024', ], ], ], 'Edge' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'EdgeDeploymentConfig' => [ 'type' => 'structure', 'required' => [ 'FailureHandlingPolicy', ], 'members' => [ 'FailureHandlingPolicy' => [ 'shape' => 'FailureHandlingPolicy', ], ], ], 'EdgeDeploymentModelConfig' => [ 'type' => 'structure', 'required' => [ 'ModelHandle', 'EdgePackagingJobName', ], 'members' => [ 'ModelHandle' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'EdgeDeploymentModelConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentModelConfig', ], ], 'EdgeDeploymentPlanArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgeDeploymentPlanSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentPlanSummary', ], ], 'EdgeDeploymentPlanSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'DeviceFleetName', 'EdgeDeploymentSuccess', 'EdgeDeploymentPending', 'EdgeDeploymentFailed', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeDeploymentStatus' => [ 'type' => 'structure', 'required' => [ 'StageStatus', 'EdgeDeploymentSuccessInStage', 'EdgeDeploymentPendingInStage', 'EdgeDeploymentFailedInStage', ], 'members' => [ 'StageStatus' => [ 'shape' => 'StageStatus', ], 'EdgeDeploymentSuccessInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPendingInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailedInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentStatusMessage' => [ 'shape' => 'String', ], 'EdgeDeploymentStageStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModel' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'LatestSampleTime' => [ 'shape' => 'Timestamp', ], 'LatestInference' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModelStat' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', 'OfflineDeviceCount', 'ConnectedDeviceCount', 'ActiveDeviceCount', 'SamplingDeviceCount', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'OfflineDeviceCount' => [ 'shape' => 'Long', ], 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'ActiveDeviceCount' => [ 'shape' => 'Long', ], 'SamplingDeviceCount' => [ 'shape' => 'Long', ], ], ], 'EdgeModelStats' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelStat', ], ], 'EdgeModelSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelSummary', ], ], 'EdgeModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'EdgeModels' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModel', ], ], 'EdgeOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'PresetDeploymentType' => [ 'shape' => 'EdgePresetDeploymentType', ], 'PresetDeploymentConfig' => [ 'shape' => 'String', ], ], ], 'EdgePackagingJobArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgePackagingJobStatus' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'INPROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'EdgePackagingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgePackagingJobSummary', ], ], 'EdgePackagingJobSummary' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgePresetDeploymentArtifact' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'EdgePresetDeploymentOutput' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'EdgePresetDeploymentType', ], 'Artifact' => [ 'shape' => 'EdgePresetDeploymentArtifact', ], 'Status' => [ 'shape' => 'EdgePresetDeploymentStatus', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], 'EdgePresetDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'FAILED', ], ], 'EdgePresetDeploymentType' => [ 'type' => 'string', 'enum' => [ 'GreengrassV2Component', ], ], 'EdgeVersion' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\ \\_\\.]+', ], 'Edges' => [ 'type' => 'list', 'member' => [ 'shape' => 'Edge', ], ], 'EfsUid' => [ 'type' => 'string', 'max' => 10, 'pattern' => '\\d+', ], 'EnableCapture' => [ 'type' => 'boolean', ], 'EnableIotRoleAlias' => [ 'type' => 'boolean', ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'Endpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointConfigName', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringSchedules' => [ 'shape' => 'MonitoringScheduleList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'EndpointArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/.*', ], 'EndpointConfigArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/.*', ], 'EndpointConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'EndpointConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'EndpointConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointConfigSummary', ], ], 'EndpointInfo' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'EndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'LocalPath', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], ], ], 'EndpointInputConfiguration' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameterRanges' => [ 'shape' => 'EnvironmentParameterRanges', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'EndpointInputConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInputConfiguration', ], 'max' => 10, 'min' => 1, ], 'EndpointMetadata' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'EndpointName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointOutputConfiguration' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'VariantName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'String', ], 'VariantName' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialInstanceCount' => [ 'shape' => 'InitialInstanceCount', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'EndpointPerformance' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointInfo', ], 'members' => [ 'Metrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointInfo' => [ 'shape' => 'EndpointInfo', ], ], ], 'EndpointPerformances' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointPerformance', ], 'max' => 1, ], 'EndpointSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'EndpointStatus' => [ 'type' => 'string', 'enum' => [ 'OutOfService', 'Creating', 'Updating', 'SystemUpdating', 'RollingBack', 'InService', 'Deleting', 'Failed', 'UpdateRollbackFailed', ], ], 'EndpointSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'EndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointSummary', ], ], 'Endpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInfo', ], 'max' => 1, ], 'EntityDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'EntityName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'EnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'EnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'EnvironmentKey', ], 'value' => [ 'shape' => 'EnvironmentValue', ], 'max' => 16, ], 'EnvironmentParameter' => [ 'type' => 'structure', 'required' => [ 'Key', 'ValueType', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'String', ], 'ValueType' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'EnvironmentParameterRanges' => [ 'type' => 'structure', 'members' => [ 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameters', ], ], ], 'EnvironmentParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentParameter', ], 'max' => 10, 'min' => 1, ], 'EnvironmentValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'ExecutionRoleIdentityConfig' => [ 'type' => 'string', 'enum' => [ 'USER_PROFILE_NAME', 'DISABLED', ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Completed', 'CompletedWithViolations', 'InProgress', 'Failed', 'Stopping', 'Stopped', ], ], 'ExitMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'Experiment' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/.*', ], 'ExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentDisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ExperimentDescription' => [ 'type' => 'string', 'max' => 3072, 'pattern' => '.*', ], 'ExperimentEntityName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'ExperimentEntityNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'ExperimentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'ExperimentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'ExperimentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'ExperimentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExperimentSummary', ], ], 'ExperimentSummary' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentSource' => [ 'shape' => 'ExperimentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ExpiresInSeconds' => [ 'type' => 'integer', 'max' => 300, 'min' => 5, ], 'Explainability' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], ], ], 'ExplainabilityLocation' => [ 'type' => 'string', 'min' => 1, ], 'ExplainerConfig' => [ 'type' => 'structure', 'members' => [ 'ClarifyExplainerConfig' => [ 'shape' => 'ClarifyExplainerConfig', ], ], ], 'FailStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String3072', ], ], ], 'FailureHandlingPolicy' => [ 'type' => 'string', 'enum' => [ 'ROLLBACK_ON_FAILURE', 'DO_NOTHING', ], ], 'FailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'FeatureAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 100, 'min' => 1, ], 'FeatureDefinition' => [ 'type' => 'structure', 'members' => [ 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], ], ], 'FeatureDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 2500, 'min' => 1, ], 'FeatureDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '.*', ], 'FeatureGroup' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'FeatureGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/.*', ], 'FeatureGroupMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'FeatureGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}', ], 'FeatureGroupNameContains' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'FeatureGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})', ], 'FeatureGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'FeatureGroupStatus', 'OfflineStoreStatus', 'CreationTime', ], ], 'FeatureGroupSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'FeatureGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'CreateFailed', 'Deleting', 'DeleteFailed', ], ], 'FeatureGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureGroupSummary', ], ], 'FeatureGroupSummary' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureGroupArn', 'CreationTime', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], ], ], 'FeatureMetadata' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'FeatureName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}', ], 'FeatureParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'FeatureParameterKey', ], 'Value' => [ 'shape' => 'FeatureParameterValue', ], ], ], 'FeatureParameterAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, ], 'FeatureParameterKey' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameterRemovals' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameterKey', ], 'max' => 25, ], 'FeatureParameterValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, 'min' => 0, ], 'FeatureStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'FeatureType' => [ 'type' => 'string', 'enum' => [ 'Integral', 'Fractional', 'String', ], ], 'FileSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'FileSystemAccessMode' => [ 'type' => 'string', 'enum' => [ 'rw', 'ro', ], ], 'FileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'MountPath' => [ 'shape' => 'MountPath', ], 'DefaultUid' => [ 'shape' => 'DefaultUid', 'box' => true, ], 'DefaultGid' => [ 'shape' => 'DefaultGid', 'box' => true, ], ], ], 'FileSystemDataSource' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', 'FileSystemAccessMode', 'FileSystemType', 'DirectoryPath', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemAccessMode' => [ 'shape' => 'FileSystemAccessMode', ], 'FileSystemType' => [ 'shape' => 'FileSystemType', ], 'DirectoryPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'FileSystemId' => [ 'type' => 'string', 'min' => 11, 'pattern' => '.*', ], 'FileSystemType' => [ 'type' => 'string', 'enum' => [ 'EFS', 'FSxLustre', ], ], 'FillingTransformationMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FillingType', ], 'value' => [ 'shape' => 'FillingTransformationValue', ], 'max' => 6, 'min' => 1, ], 'FillingTransformationValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-]+$', ], 'FillingTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'FillingTransformationMap', ], 'max' => 50, 'min' => 1, ], 'FillingType' => [ 'type' => 'string', 'enum' => [ 'frontfill', 'middlefill', 'backfill', 'futurefill', 'frontfill_value', 'middlefill_value', 'backfill_value', 'futurefill_value', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'ResourcePropertyName', ], 'Operator' => [ 'shape' => 'Operator', ], 'Value' => [ 'shape' => 'FilterValue', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'max' => 20, 'min' => 1, ], 'FilterValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'FinalAutoMLJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'AutoMLJobObjectiveType', ], 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'MetricValue', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'MetricValue', ], ], ], 'FinalMetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricData', ], 'max' => 40, 'min' => 0, ], 'FlatInvocations' => [ 'type' => 'string', 'enum' => [ 'Continue', 'Stop', ], ], 'Float' => [ 'type' => 'float', ], 'FlowDefinitionArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:flow-definition/.*', ], 'FlowDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9]){0,62}', ], 'FlowDefinitionOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'FlowDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Active', 'Failed', 'Deleting', ], ], 'FlowDefinitionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionSummary', ], ], 'FlowDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'FlowDefinitionArn', 'FlowDefinitionStatus', 'CreationTime', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'max' => 864000, 'min' => 1, ], 'FlowDefinitionTaskCount' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'FlowDefinitionTaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'FlowDefinitionTaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'FlowDefinitionTaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionTaskKeyword', ], 'max' => 5, 'min' => 1, ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'type' => 'integer', 'max' => 28800, 'min' => 30, ], 'FlowDefinitionTaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'ForecastFrequency' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$', ], 'ForecastHorizon' => [ 'type' => 'integer', 'min' => 1, ], 'ForecastQuantile' => [ 'type' => 'string', 'max' => 4, 'min' => 2, 'pattern' => '(^p[1-9]\\d?$)', ], 'ForecastQuantiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ForecastQuantile', ], 'max' => 5, 'min' => 1, ], 'Framework' => [ 'type' => 'string', 'enum' => [ 'TENSORFLOW', 'KERAS', 'MXNET', 'ONNX', 'PYTORCH', 'XGBOOST', 'TFLITE', 'DARKNET', 'SKLEARN', ], ], 'FrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.]+', ], 'GenerateCandidateDefinitionsOnly' => [ 'type' => 'boolean', ], 'GetDeviceFleetReportRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'GetDeviceFleetReportResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'ReportGenerated' => [ 'shape' => 'Timestamp', ], 'DeviceStats' => [ 'shape' => 'DeviceStats', ], 'AgentVersions' => [ 'shape' => 'AgentVersions', ], 'ModelStats' => [ 'shape' => 'EdgeModelStats', ], ], ], 'GetLineageGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'LineageGroupNameOrArn', ], ], ], 'GetLineageGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'ResourcePolicy' => [ 'shape' => 'ResourcePolicyString', ], ], ], 'GetModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'GetModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ResourcePolicy', ], 'members' => [ 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'type' => 'structure', 'members' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'SagemakerServicecatalogStatus', ], ], ], 'GetScalingConfigurationRecommendationRequest' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobName', ], 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], ], ], 'GetScalingConfigurationRecommendationResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], 'Metric' => [ 'shape' => 'ScalingPolicyMetric', ], 'DynamicScalingConfiguration' => [ 'shape' => 'DynamicScalingConfiguration', ], ], ], 'GetSearchSuggestionsRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SuggestionQuery' => [ 'shape' => 'SuggestionQuery', ], ], ], 'GetSearchSuggestionsResponse' => [ 'type' => 'structure', 'members' => [ 'PropertyNameSuggestions' => [ 'shape' => 'PropertyNameSuggestionList', ], ], ], 'GitConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'GitConfigUrl', ], 'Branch' => [ 'shape' => 'Branch', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigUrl' => [ 'type' => 'string', 'pattern' => '^https://([^/]+)/?(.*)$', ], 'Group' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'GroupingAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'GroupingAttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupingAttributeName', ], 'max' => 5, 'min' => 1, ], 'Groups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], 'max' => 10, 'min' => 1, ], 'HookParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'Horovod' => [ 'type' => 'boolean', ], 'HubArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDependency' => [ 'type' => 'structure', 'members' => [ 'DependencyOriginPath' => [ 'shape' => 'DependencyOriginPath', ], 'DependencyCopyPath' => [ 'shape' => 'DependencyCopyPath', ], ], ], 'HubContentDependencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentDependency', ], 'max' => 50, ], 'HubContentDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubContentDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDocument' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentInfo' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubContentInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentInfo', ], ], 'HubContentMarkdown' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubContentSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubContentSortBy' => [ 'type' => 'string', 'enum' => [ 'HubContentName', 'CreationTime', 'HubContentStatus', ], ], 'HubContentStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Importing', 'Deleting', 'ImportFailed', 'DeleteFailed', ], ], 'HubContentType' => [ 'type' => 'string', 'enum' => [ 'Model', 'Notebook', ], ], 'HubContentVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'HubDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubInfo' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubInfo', ], ], 'HubName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubS3StorageConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3OutputPath', ], ], ], 'HubSearchKeyword' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[^A-Z]*$', ], 'HubSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubSortBy' => [ 'type' => 'string', 'enum' => [ 'HubName', 'CreationTime', 'HubStatus', 'AccountIdOwner', ], ], 'HubStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Deleting', 'CreateFailed', 'UpdateFailed', 'DeleteFailed', ], ], 'HumanLoopActivationConditions' => [ 'type' => 'string', 'max' => 10240, ], 'HumanLoopActivationConditionsConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditions', ], 'members' => [ 'HumanLoopActivationConditions' => [ 'shape' => 'HumanLoopActivationConditions', 'jsonvalue' => true, ], ], ], 'HumanLoopActivationConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditionsConfig', ], 'members' => [ 'HumanLoopActivationConditionsConfig' => [ 'shape' => 'HumanLoopActivationConditionsConfig', ], ], ], 'HumanLoopConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'HumanTaskUiArn', 'TaskTitle', 'TaskDescription', 'TaskCount', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'TaskTitle' => [ 'shape' => 'FlowDefinitionTaskTitle', ], 'TaskDescription' => [ 'shape' => 'FlowDefinitionTaskDescription', ], 'TaskCount' => [ 'shape' => 'FlowDefinitionTaskCount', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'FlowDefinitionTaskAvailabilityLifetimeInSeconds', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'FlowDefinitionTaskTimeLimitInSeconds', ], 'TaskKeywords' => [ 'shape' => 'FlowDefinitionTaskKeywords', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanLoopRequestSource' => [ 'type' => 'structure', 'required' => [ 'AwsManagedHumanLoopRequestSource', ], 'members' => [ 'AwsManagedHumanLoopRequestSource' => [ 'shape' => 'AwsManagedHumanLoopRequestSource', ], ], ], 'HumanTaskConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'UiConfig', 'PreHumanTaskLambdaArn', 'TaskTitle', 'TaskDescription', 'NumberOfHumanWorkersPerDataObject', 'TaskTimeLimitInSeconds', 'AnnotationConsolidationConfig', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'UiConfig' => [ 'shape' => 'UiConfig', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'TaskKeywords' => [ 'shape' => 'TaskKeywords', ], 'TaskTitle' => [ 'shape' => 'TaskTitle', ], 'TaskDescription' => [ 'shape' => 'TaskDescription', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'TaskTimeLimitInSeconds', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'TaskAvailabilityLifetimeInSeconds', ], 'MaxConcurrentTaskCount' => [ 'shape' => 'MaxConcurrentTaskCount', ], 'AnnotationConsolidationConfig' => [ 'shape' => 'AnnotationConsolidationConfig', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanTaskUiArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:human-task-ui/.*', ], 'HumanTaskUiName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9])*', ], 'HumanTaskUiStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'HumanTaskUiSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HumanTaskUiSummary', ], ], 'HumanTaskUiSummary' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'HumanTaskUiArn', 'CreationTime', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], ], ], 'HyperParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'HyperParameterScalingType' => [ 'type' => 'string', 'enum' => [ 'Auto', 'Linear', 'Logarithmic', 'ReverseLogarithmic', ], ], 'HyperParameterSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Type' => [ 'shape' => 'ParameterType', ], 'Range' => [ 'shape' => 'ParameterRange', ], 'IsTunable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'DefaultValue' => [ 'shape' => 'HyperParameterValue', ], ], ], 'HyperParameterSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterSpecification', ], 'max' => 100, 'min' => 0, ], 'HyperParameterTrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'StoppingCondition', ], 'members' => [ 'DefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TuningObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'HyperParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'StaticHyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'HyperParameterAlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'HyperParameterTuningResourceConfig' => [ 'shape' => 'HyperParameterTuningResourceConfig', ], 'Environment' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentMap', ], ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'HyperParameterTrainingJobDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'max' => 10, 'min' => 1, ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentKey', ], 'value' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentValue', ], 'max' => 48, ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'HyperParameterTrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], ], 'HyperParameterTrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', 'TunedHyperParameters', ], 'members' => [ 'TrainingJobDefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'TunedHyperParameters' => [ 'shape' => 'HyperParameters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'shape' => 'FinalHyperParameterTuningJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], ], ], 'HyperParameterTuningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'Prioritized', ], ], 'HyperParameterTuningInstanceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], ], ], 'HyperParameterTuningInstanceConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningInstanceConfig', ], 'max' => 6, 'min' => 1, ], 'HyperParameterTuningJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*', ], 'HyperParameterTuningJobCompletionDetails' => [ 'type' => 'structure', 'members' => [ 'NumberOfTrainingJobsObjectiveNotImproving' => [ 'shape' => 'Integer', ], 'ConvergenceDetectedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterTuningJobConfig' => [ 'type' => 'structure', 'required' => [ 'Strategy', 'ResourceLimits', ], 'members' => [ 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'StrategyConfig' => [ 'shape' => 'HyperParameterTuningJobStrategyConfig', ], 'HyperParameterTuningJobObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], 'ParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'TrainingJobEarlyStoppingType' => [ 'shape' => 'TrainingJobEarlyStoppingType', ], 'TuningJobCompletionCriteria' => [ 'shape' => 'TuningJobCompletionCriteria', ], 'RandomSeed' => [ 'shape' => 'RandomSeed', ], ], ], 'HyperParameterTuningJobConsumedResources' => [ 'type' => 'structure', 'members' => [ 'RuntimeInSeconds' => [ 'shape' => 'Integer', ], ], ], 'HyperParameterTuningJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'HyperParameterTuningJobObjective' => [ 'type' => 'structure', 'required' => [ 'Type', 'MetricName', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], ], ], 'HyperParameterTuningJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'HyperParameterTuningJobObjectives' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobObjective', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Tags' => [ 'shape' => 'TagList', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], ], ], 'HyperParameterTuningJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'Status', 'CreationTime', ], ], 'HyperParameterTuningJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'HyperbandStrategyConfig' => [ 'shape' => 'HyperbandStrategyConfig', ], ], ], 'HyperParameterTuningJobStrategyType' => [ 'type' => 'string', 'enum' => [ 'Bayesian', 'Random', 'Hyperband', 'Grid', ], ], 'HyperParameterTuningJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobSummary', ], ], 'HyperParameterTuningJobSummary' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobStatus', 'Strategy', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'type' => 'structure', 'required' => [ 'ParentHyperParameterTuningJobs', 'WarmStartType', ], 'members' => [ 'ParentHyperParameterTuningJobs' => [ 'shape' => 'ParentHyperParameterTuningJobs', ], 'WarmStartType' => [ 'shape' => 'HyperParameterTuningJobWarmStartType', ], ], ], 'HyperParameterTuningJobWarmStartType' => [ 'type' => 'string', 'enum' => [ 'IdenticalDataAndAlgorithm', 'TransferLearning', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 15768000, 'min' => 120, ], 'HyperParameterTuningResourceConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AllocationStrategy' => [ 'shape' => 'HyperParameterTuningAllocationStrategy', ], 'InstanceConfigs' => [ 'shape' => 'HyperParameterTuningInstanceConfigs', ], ], ], 'HyperParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'HyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterKey', ], 'value' => [ 'shape' => 'HyperParameterValue', ], 'max' => 100, 'min' => 0, ], 'HyperbandStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'MinResource' => [ 'shape' => 'HyperbandStrategyMinResource', ], 'MaxResource' => [ 'shape' => 'HyperbandStrategyMaxResource', ], ], ], 'HyperbandStrategyMaxResource' => [ 'type' => 'integer', 'min' => 1, ], 'HyperbandStrategyMinResource' => [ 'type' => 'integer', 'min' => 1, ], 'IamIdentity' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String', ], 'PrincipalId' => [ 'shape' => 'String', ], 'SourceIdentity' => [ 'shape' => 'String', ], ], ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 128, 'min' => 32, ], 'Image' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageName', 'ImageStatus', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ImageArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$', ], 'ImageBaseImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'ImageClassificationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ImageConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryAccessMode', ], 'members' => [ 'RepositoryAccessMode' => [ 'shape' => 'RepositoryAccessMode', ], 'RepositoryAuthConfig' => [ 'shape' => 'RepositoryAuthConfig', ], ], ], 'ImageContainerImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ImageDeleteProperty' => [ 'type' => 'string', 'max' => 11, 'min' => 1, 'pattern' => '(^DisplayName$)|(^Description$)', ], 'ImageDeletePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageDeleteProperty', ], 'max' => 2, ], 'ImageDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*', ], 'ImageDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ImageDisplayName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^\\S(.*\\S)?$', ], 'ImageName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$', ], 'ImageNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9\\-.]+$', ], 'ImageSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'IMAGE_NAME', ], ], 'ImageSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageUri' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'ImageVersion' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageVersionArn', 'ImageVersionStatus', 'LastModifiedTime', 'Version', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], ], ], 'ImageVersionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$', ], 'ImageVersionNumber' => [ 'type' => 'integer', 'min' => 0, ], 'ImageVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'VERSION', ], ], 'ImageVersionSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageVersionStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageVersion', ], ], 'Images' => [ 'type' => 'list', 'member' => [ 'shape' => 'Image', ], ], 'ImportHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubContentDocument', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ImportHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', 'HubContentArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], ], ], 'InferenceExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'InferenceExecutionMode', ], ], ], 'InferenceExecutionMode' => [ 'type' => 'string', 'enum' => [ 'Serial', 'Direct', ], ], 'InferenceExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/.*', ], 'InferenceExperimentDataStorageConfig' => [ 'type' => 'structure', 'required' => [ 'Destination', ], 'members' => [ 'Destination' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'ContentType' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'InferenceExperimentDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceExperimentSummary', ], ], 'InferenceExperimentName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'InferenceExperimentSchedule' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceExperimentStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'Updating', 'Running', 'Starting', 'Stopping', 'Completed', 'Cancelled', ], ], 'InferenceExperimentStatusReason' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentStopDesiredState' => [ 'type' => 'string', 'enum' => [ 'Completed', 'Cancelled', ], ], 'InferenceExperimentSummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'Status', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'InferenceExperimentType' => [ 'type' => 'string', 'enum' => [ 'ShadowMode', ], ], 'InferenceImage' => [ 'type' => 'string', 'max' => 256, ], 'InferenceMetrics' => [ 'type' => 'structure', 'required' => [ 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'InferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointConfiguration', 'ModelConfiguration', ], 'members' => [ 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'RecommendationId' => [ 'shape' => 'String', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'InferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendation', ], 'max' => 10, 'min' => 1, ], 'InferenceRecommendationsJob' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobDescription', 'JobType', 'JobArn', 'Status', 'CreationTime', 'RoleArn', 'LastModifiedTime', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'InferenceRecommendationsJobStep' => [ 'type' => 'structure', 'required' => [ 'StepType', 'JobName', 'Status', ], 'members' => [ 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'InferenceBenchmark' => [ 'shape' => 'RecommendationJobInferenceBenchmark', ], ], ], 'InferenceRecommendationsJobSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJobStep', ], ], 'InferenceRecommendationsJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJob', ], ], 'InferenceSpecification' => [ 'type' => 'structure', 'required' => [ 'Containers', 'SupportedContentTypes', 'SupportedResponseMIMETypes', ], 'members' => [ 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'InferenceSpecificationName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'InitialInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InitialNumberOfUsers' => [ 'type' => 'integer', 'min' => 1, ], 'InitialTaskCount' => [ 'type' => 'integer', 'min' => 1, ], 'InputConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'DataInputConfig', 'Framework', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], 'Framework' => [ 'shape' => 'Framework', ], 'FrameworkVersion' => [ 'shape' => 'FrameworkVersion', ], ], ], 'InputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], 'max' => 20, 'min' => 1, ], 'InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'InputModes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInputMode', ], 'min' => 1, ], 'InstanceGroup' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'InstanceGroupName', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'InstanceGroupName', ], ], ], 'InstanceGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.+', ], 'InstanceGroupNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupName', ], 'max' => 5, ], 'InstanceGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroup', ], 'max' => 5, ], 'InstanceMetadataServiceConfiguration' => [ 'type' => 'structure', 'required' => [ 'MinimumInstanceMetadataServiceVersion', ], 'members' => [ 'MinimumInstanceMetadataServiceVersion' => [ 'shape' => 'MinimumInstanceMetadataServiceVersion', ], ], ], 'InstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'IntegerParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'IntegerParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerParameterRange', ], 'max' => 30, 'min' => 0, ], 'IntegerValue' => [ 'type' => 'integer', ], 'InvocationEndTime' => [ 'type' => 'timestamp', ], 'InvocationStartTime' => [ 'type' => 'timestamp', ], 'InvocationsMaxRetries' => [ 'type' => 'integer', 'max' => 3, 'min' => 0, ], 'InvocationsTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 1, ], 'IotRoleAlias' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'ItemIdentifierAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'JobDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'JobReferenceCode' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.+', ], 'JobReferenceCodeContains' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'JobType' => [ 'type' => 'string', 'enum' => [ 'TRAINING', 'INFERENCE', 'NOTEBOOK_KERNEL', ], ], 'JoinSource' => [ 'type' => 'string', 'enum' => [ 'Input', 'None', ], ], 'JsonContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'JsonContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'JsonContentType', ], 'max' => 10, 'min' => 1, ], 'JsonPath' => [ 'type' => 'string', 'max' => 63, 'min' => 0, ], 'JupyterServerAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'KeepAlivePeriodInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'KernelDisplayName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelGatewayAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'KernelGatewayImageConfig' => [ 'type' => 'structure', 'required' => [ 'KernelSpecs', ], 'members' => [ 'KernelSpecs' => [ 'shape' => 'KernelSpecs', ], 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], ], ], 'KernelName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelSpec' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'KernelName', ], 'DisplayName' => [ 'shape' => 'KernelDisplayName', ], ], ], 'KernelSpecs' => [ 'type' => 'list', 'member' => [ 'shape' => 'KernelSpec', ], 'max' => 1, 'min' => 1, ], 'Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'LabelAttributeName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}', ], 'LabelCounter' => [ 'type' => 'integer', 'min' => 0, ], 'LabelCounters' => [ 'type' => 'structure', 'members' => [ 'TotalLabeled' => [ 'shape' => 'LabelCounter', ], 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'MachineLabeled' => [ 'shape' => 'LabelCounter', ], 'FailedNonRetryableError' => [ 'shape' => 'LabelCounter', ], 'Unlabeled' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelCountersForWorkteam' => [ 'type' => 'structure', 'members' => [ 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'PendingHuman' => [ 'shape' => 'LabelCounter', ], 'Total' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:.*', ], 'LabelingJobAlgorithmsConfig' => [ 'type' => 'structure', 'required' => [ 'LabelingJobAlgorithmSpecificationArn', ], 'members' => [ 'LabelingJobAlgorithmSpecificationArn' => [ 'shape' => 'LabelingJobAlgorithmSpecificationArn', ], 'InitialActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], 'LabelingJobResourceConfig' => [ 'shape' => 'LabelingJobResourceConfig', ], ], ], 'LabelingJobArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/.*', ], 'LabelingJobDataAttributes' => [ 'type' => 'structure', 'members' => [ 'ContentClassifiers' => [ 'shape' => 'ContentClassifiers', ], ], ], 'LabelingJobDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'LabelingJobS3DataSource', ], 'SnsDataSource' => [ 'shape' => 'LabelingJobSnsDataSource', ], ], ], 'LabelingJobForWorkteamSummary' => [ 'type' => 'structure', 'required' => [ 'JobReferenceCode', 'WorkRequesterAccountId', 'CreationTime', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'WorkRequesterAccountId' => [ 'shape' => 'AccountId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LabelCounters' => [ 'shape' => 'LabelCountersForWorkteam', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], ], ], 'LabelingJobForWorkteamSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobForWorkteamSummary', ], ], 'LabelingJobInputConfig' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'LabelingJobDataSource', ], 'DataAttributes' => [ 'shape' => 'LabelingJobDataAttributes', ], ], ], 'LabelingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'LabelingJobOutput' => [ 'type' => 'structure', 'required' => [ 'OutputDatasetS3Uri', ], 'members' => [ 'OutputDatasetS3Uri' => [ 'shape' => 'S3Uri', ], 'FinalActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'LabelingJobOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobResourceConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'LabelingJobS3DataSource' => [ 'type' => 'structure', 'required' => [ 'ManifestS3Uri', ], 'members' => [ 'ManifestS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'LabelingJobSnsDataSource' => [ 'type' => 'structure', 'required' => [ 'SnsTopicArn', ], 'members' => [ 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'LabelingJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxHumanLabeledObjectCount' => [ 'shape' => 'MaxHumanLabeledObjectCount', ], 'MaxPercentageOfInputDatasetLabeled' => [ 'shape' => 'MaxPercentageOfInputDatasetLabeled', ], ], ], 'LabelingJobSummary' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelingJobArn', 'CreationTime', 'LastModifiedTime', 'LabelingJobStatus', 'LabelCounters', 'WorkteamArn', 'PreHumanTaskLambdaArn', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], ], ], 'LabelingJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobSummary', ], ], 'LambdaFunctionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:.*', ], 'LambdaStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'LastModifiedTime' => [ 'type' => 'timestamp', ], 'LastUpdateStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'LastUpdateStatusValue', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'LastUpdateStatusValue' => [ 'type' => 'string', 'enum' => [ 'Successful', 'Failed', 'InProgress', ], ], 'LifecycleConfigArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], 'LineageEntityParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'StringParameterValue', ], 'max' => 30, ], 'LineageGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/.*', ], 'LineageGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'LineageGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageGroupSummary', ], ], 'LineageGroupSummary' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'LineageType' => [ 'type' => 'string', 'enum' => [ 'TrialComponent', 'Artifact', 'Context', 'Action', ], ], 'ListActionsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ActionType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortActionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ActionSummaries' => [ 'shape' => 'ActionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAlgorithmsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'AlgorithmSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAlgorithmsOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSummaryList', ], 'members' => [ 'AlgorithmSummaryList' => [ 'shape' => 'AlgorithmSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageVersionAliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppImageConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'AppImageConfigName', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'AppImageConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAppImageConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'AppImageConfigs' => [ 'shape' => 'AppImageConfigList', ], ], ], 'ListAppsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'AppSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameEquals' => [ 'shape' => 'UserProfileName', ], 'SpaceNameEquals' => [ 'shape' => 'SpaceName', ], ], ], 'ListAppsResponse' => [ 'type' => 'structure', 'members' => [ 'Apps' => [ 'shape' => 'AppList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListArtifactsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortArtifactsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListArtifactsResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactSummaries' => [ 'shape' => 'ArtifactSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortAssociationsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationSummaries' => [ 'shape' => 'AssociationSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'AutoMLNameContains', ], 'StatusEquals' => [ 'shape' => 'AutoMLJobStatus', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'AutoMLSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobSummaries', ], 'members' => [ 'AutoMLJobSummaries' => [ 'shape' => 'AutoMLJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'StatusEquals' => [ 'shape' => 'CandidateStatus', ], 'CandidateNameEquals' => [ 'shape' => 'CandidateName', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'CandidateSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'Candidates', ], 'members' => [ 'Candidates' => [ 'shape' => 'AutoMLCandidates', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCodeRepositoriesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'CodeRepositoryNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'CodeRepositorySortBy', ], 'SortOrder' => [ 'shape' => 'CodeRepositorySortOrder', ], ], ], 'ListCodeRepositoriesOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositorySummaryList', ], 'members' => [ 'CodeRepositorySummaryList' => [ 'shape' => 'CodeRepositorySummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'CompilationJobStatus', ], 'SortBy' => [ 'shape' => 'ListCompilationJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListCompilationJobsResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobSummaries', ], 'members' => [ 'CompilationJobSummaries' => [ 'shape' => 'CompilationJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListContextsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortContextsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListContextsResponse' => [ 'type' => 'structure', 'members' => [ 'ContextSummaries' => [ 'shape' => 'ContextSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListDataQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListDeviceFleetsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListDeviceFleetsResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetSummaries', ], 'members' => [ 'DeviceFleetSummaries' => [ 'shape' => 'DeviceFleetSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListDevicesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'LatestHeartbeatAfter' => [ 'shape' => 'Timestamp', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'ListDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceSummaries', ], 'members' => [ 'DeviceSummaries' => [ 'shape' => 'DeviceSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Domains' => [ 'shape' => 'DomainList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'DeviceFleetNameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListEdgeDeploymentPlansSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgeDeploymentPlansResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanSummaries', ], 'members' => [ 'EdgeDeploymentPlanSummaries' => [ 'shape' => 'EdgeDeploymentPlanSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'DEVICE_FLEET_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListEdgePackagingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelNameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'EdgePackagingJobStatus', ], 'SortBy' => [ 'shape' => 'ListEdgePackagingJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgePackagingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobSummaries', ], 'members' => [ 'EdgePackagingJobSummaries' => [ 'shape' => 'EdgePackagingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgePackagingJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'MODEL_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'STATUS', ], ], 'ListEndpointConfigsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointConfigSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListEndpointConfigsOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigs', ], 'members' => [ 'EndpointConfigs' => [ 'shape' => 'EndpointConfigSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListEndpointsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'EndpointStatus', ], ], ], 'ListEndpointsOutput' => [ 'type' => 'structure', 'required' => [ 'Endpoints', ], 'members' => [ 'Endpoints' => [ 'shape' => 'EndpointSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentSummaries' => [ 'shape' => 'ExperimentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'FeatureGroupNameContains', ], 'FeatureGroupStatusEquals' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatusEquals' => [ 'shape' => 'OfflineStoreStatusValue', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'SortOrder' => [ 'shape' => 'FeatureGroupSortOrder', ], 'SortBy' => [ 'shape' => 'FeatureGroupSortBy', ], 'MaxResults' => [ 'shape' => 'FeatureGroupMaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupSummaries', 'NextToken', ], 'members' => [ 'FeatureGroupSummaries' => [ 'shape' => 'FeatureGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFlowDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListFlowDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionSummaries', ], 'members' => [ 'FlowDefinitionSummaries' => [ 'shape' => 'FlowDefinitionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'MinVersion' => [ 'shape' => 'HubContentVersion', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsResponse' => [ 'type' => 'structure', 'required' => [ 'HubSummaries', ], 'members' => [ 'HubSummaries' => [ 'shape' => 'HubInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHumanTaskUisRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListHumanTaskUisResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiSummaries', ], 'members' => [ 'HumanTaskUiSummaries' => [ 'shape' => 'HumanTaskUiSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHyperParameterTuningJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'SortBy' => [ 'shape' => 'HyperParameterTuningJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'HyperParameterTuningJobStatus', ], ], ], 'ListHyperParameterTuningJobsResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobSummaries', ], 'members' => [ 'HyperParameterTuningJobSummaries' => [ 'shape' => 'HyperParameterTuningJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ImageVersionSortOrder', ], ], ], 'ListImageVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersions' => [ 'shape' => 'ImageVersions', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImagesRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ImageNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageSortBy', ], 'SortOrder' => [ 'shape' => 'ImageSortOrder', ], ], ], 'ListImagesResponse' => [ 'type' => 'structure', 'members' => [ 'Images' => [ 'shape' => 'Images', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'StatusEquals' => [ 'shape' => 'InferenceExperimentStatus', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortInferenceExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListInferenceExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceExperiments' => [ 'shape' => 'InferenceExperimentList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'InferenceRecommendationsJobSteps', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'RecommendationJobStatus', ], 'SortBy' => [ 'shape' => 'ListInferenceRecommendationsJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelNameEquals' => [ 'shape' => 'ModelName', ], 'ModelPackageVersionArnEquals' => [ 'shape' => 'ModelPackageArn', ], ], ], 'ListInferenceRecommendationsJobsResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobs', ], 'members' => [ 'InferenceRecommendationsJobs' => [ 'shape' => 'InferenceRecommendationsJobs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'JobReferenceCodeContains' => [ 'shape' => 'JobReferenceCodeContains', ], 'SortBy' => [ 'shape' => 'ListLabelingJobsForWorkteamSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListLabelingJobsForWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobSummaryList', ], 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobForWorkteamSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ListLabelingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'StatusEquals' => [ 'shape' => 'LabelingJobStatus', ], ], ], 'ListLabelingJobsResponse' => [ 'type' => 'structure', 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLineageEntityParameterKey' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringParameterValue', ], ], 'ListLineageGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortLineageGroupsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListLineageGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupSummaries' => [ 'shape' => 'LineageGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'ListModelBiasJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelBiasJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModelCardExportJobNameContains' => [ 'shape' => 'EntityName', ], 'StatusEquals' => [ 'shape' => 'ModelCardExportJobStatus', ], 'SortBy' => [ 'shape' => 'ModelCardExportJobSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardExportJobSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelCardExportJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobSummaries', ], 'members' => [ 'ModelCardExportJobSummaries' => [ 'shape' => 'ModelCardExportJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardVersionSummaryList', ], 'members' => [ 'ModelCardVersionSummaryList' => [ 'shape' => 'ModelCardVersionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EntityName', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardSummaries', ], 'members' => [ 'ModelCardSummaries' => [ 'shape' => 'ModelCardSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelMetadataRequest' => [ 'type' => 'structure', 'members' => [ 'SearchExpression' => [ 'shape' => 'ModelMetadataSearchExpression', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'ModelMetadataSummaries', ], 'members' => [ 'ModelMetadataSummaries' => [ 'shape' => 'ModelMetadataSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackageGroupsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageGroupSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackageGroupsOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupSummaryList', ], 'members' => [ 'ModelPackageGroupSummaryList' => [ 'shape' => 'ModelPackageGroupSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackagesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageType' => [ 'shape' => 'ModelPackageType', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackagesOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageSummaryList', ], 'members' => [ 'ModelPackageSummaryList' => [ 'shape' => 'ModelPackageSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ModelSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ModelNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelsOutput' => [ 'type' => 'structure', 'required' => [ 'Models', ], 'members' => [ 'Models' => [ 'shape' => 'ModelSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListMonitoringAlertHistoryRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'SortBy' => [ 'shape' => 'MonitoringAlertHistorySortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'ListMonitoringAlertHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertHistory' => [ 'shape' => 'MonitoringAlertHistoryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringAlertsRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMonitoringAlertsResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringExecutionsRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringExecutionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ScheduledTimeBefore' => [ 'shape' => 'Timestamp', ], 'ScheduledTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ExecutionStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringExecutionsResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringExecutionSummaries', ], 'members' => [ 'MonitoringExecutionSummaries' => [ 'shape' => 'MonitoringExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringSchedulesRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringScheduleSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringSchedulesResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleSummaries', ], 'members' => [ 'MonitoringScheduleSummaries' => [ 'shape' => 'MonitoringScheduleSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], ], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstanceLifecycleConfigs' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummaryList', ], ], ], 'ListNotebookInstancesInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'StatusEquals' => [ 'shape' => 'NotebookInstanceStatus', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepositoryContains' => [ 'shape' => 'CodeRepositoryContains', ], 'AdditionalCodeRepositoryEquals' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], ], ], 'ListNotebookInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstances' => [ 'shape' => 'NotebookInstanceSummaryList', ], ], ], 'ListPipelineExecutionStepsRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListPipelineExecutionStepsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSteps' => [ 'shape' => 'PipelineExecutionStepList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineExecutionsRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelineExecutionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineExecutionsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSummaries' => [ 'shape' => 'PipelineExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineParametersForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineParametersForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelinesRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineNamePrefix' => [ 'shape' => 'PipelineName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelinesBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelinesResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineSummaries' => [ 'shape' => 'PipelineSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProcessingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'String', ], 'StatusEquals' => [ 'shape' => 'ProcessingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListProcessingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobSummaries', ], 'members' => [ 'ProcessingJobSummaries' => [ 'shape' => 'ProcessingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProjectsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ProjectEntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ProjectSortBy', ], 'SortOrder' => [ 'shape' => 'ProjectSortOrder', ], ], ], 'ListProjectsOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectSummaryList', ], 'members' => [ 'ProjectSummaryList' => [ 'shape' => 'ProjectSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'ResourceCatalogName', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'ResourceCatalogSortOrder', ], 'SortBy' => [ 'shape' => 'ResourceCatalogSortBy', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceCatalogs' => [ 'shape' => 'ResourceCatalogList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSpacesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'SpaceSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'SpaceNameContains' => [ 'shape' => 'SpaceName', ], ], ], 'ListSpacesResponse' => [ 'type' => 'structure', 'members' => [ 'Spaces' => [ 'shape' => 'SpaceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStageDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ExcludeDevicesDeployedInOtherStage' => [ 'shape' => 'Boolean', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'ListStageDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceDeploymentSummaries', ], 'members' => [ 'DeviceDeploymentSummaries' => [ 'shape' => 'DeviceDeploymentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStudioLifecycleConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'StudioLifecycleConfigName', ], 'AppTypeEquals' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'StudioLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListStudioLifecycleConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'StudioLifecycleConfigs' => [ 'shape' => 'StudioLifecycleConfigsList', ], ], ], 'ListSubscribedWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListSubscribedWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteams', ], 'members' => [ 'SubscribedWorkteams' => [ 'shape' => 'SubscribedWorkteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListTagsMaxResults', ], ], ], 'ListTagsMaxResults' => [ 'type' => 'integer', 'min' => 50, ], 'ListTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'TrainingJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'HyperParameterTrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'WarmPoolStatusEquals' => [ 'shape' => 'WarmPoolResourceStatus', ], ], ], 'ListTrainingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'TrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTransformJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TransformJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListTransformJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobSummaries', ], 'members' => [ 'TransformJobSummaries' => [ 'shape' => 'TransformJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentKey256' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentKey256', ], ], 'ListTrialComponentsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'SourceArn' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialComponentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialSummaries' => [ 'shape' => 'TrialSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'UserProfileSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameContains' => [ 'shape' => 'UserProfileName', ], ], ], 'ListUserProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfiles' => [ 'shape' => 'UserProfileList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkforcesSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkforceName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkforcesResponse' => [ 'type' => 'structure', 'required' => [ 'Workforces', ], 'members' => [ 'Workforces' => [ 'shape' => 'Workforces', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'ListWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkteamsSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'Workteams', ], 'members' => [ 'Workteams' => [ 'shape' => 'Workteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkteamsSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'Long' => [ 'type' => 'long', ], 'MLFramework' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxCandidates' => [ 'type' => 'integer', 'max' => 750, 'min' => 1, ], 'MaxConcurrentInvocationsPerInstance' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'MaxConcurrentTaskCount' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'MaxConcurrentTransforms' => [ 'type' => 'integer', 'min' => 0, ], 'MaxHumanLabeledObjectCount' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'type' => 'integer', 'min' => 3, ], 'MaxParallelExecutionSteps' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxPayloadInMB' => [ 'type' => 'integer', 'min' => 0, ], 'MaxPercentageOfInputDatasetLabeled' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxWaitTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaximumExecutionTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 28800, 'min' => 600, ], 'MaximumRetryAttempts' => [ 'type' => 'integer', 'max' => 30, 'min' => 1, ], 'MediaType' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[-\\w]+\\/[-\\w+]+$', ], 'MemberDefinition' => [ 'type' => 'structure', 'members' => [ 'CognitoMemberDefinition' => [ 'shape' => 'CognitoMemberDefinition', ], 'OidcMemberDefinition' => [ 'shape' => 'OidcMemberDefinition', ], ], ], 'MemberDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberDefinition', ], 'max' => 10, 'min' => 1, ], 'MetadataProperties' => [ 'type' => 'structure', 'members' => [ 'CommitId' => [ 'shape' => 'MetadataPropertyValue', ], 'Repository' => [ 'shape' => 'MetadataPropertyValue', ], 'GeneratedBy' => [ 'shape' => 'MetadataPropertyValue', ], 'ProjectId' => [ 'shape' => 'MetadataPropertyValue', ], ], ], 'MetadataPropertyValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'MetricData' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'Float', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'MetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatum', ], 'max' => 40, 'min' => 0, ], 'MetricDatum' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'Float', ], 'Set' => [ 'shape' => 'MetricSetSource', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricExtendedEnum', ], ], ], 'MetricDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Regex', ], 'members' => [ 'Name' => [ 'shape' => 'MetricName', ], 'Regex' => [ 'shape' => 'MetricRegex', ], ], ], 'MetricDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDefinition', ], 'max' => 40, 'min' => 0, ], 'MetricName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'MetricRegex' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.+', ], 'MetricSetSource' => [ 'type' => 'string', 'enum' => [ 'Train', 'Validation', 'Test', ], ], 'MetricSpecification' => [ 'type' => 'structure', 'members' => [ 'Predefined' => [ 'shape' => 'PredefinedMetricSpecification', ], 'Customized' => [ 'shape' => 'CustomizedMetricSpecification', ], ], 'union' => true, ], 'MetricValue' => [ 'type' => 'float', ], 'MetricsSource' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'type' => 'string', 'max' => 1, 'pattern' => '1|2', ], 'Model' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'ModelApprovalStatus' => [ 'type' => 'string', 'enum' => [ 'Approved', 'Rejected', 'PendingManualApproval', ], ], 'ModelArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model/.*', ], 'ModelArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ModelArtifacts', ], 'members' => [ 'S3ModelArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelBiasAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelBiasBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelBiasJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelCacheSetting' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], 'ModelPackageGroupName' => [ 'shape' => 'String', ], ], ], 'ModelCardArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardContent' => [ 'type' => 'string', 'max' => 100000, 'min' => 0, 'pattern' => '.*', 'sensitive' => true, ], 'ModelCardExportArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ExportArtifacts', ], 'members' => [ 'S3ExportArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardExportJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardExportJobSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ModelCardExportJobSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', ], ], 'ModelCardExportJobSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardExportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardExportJobSummary', ], ], 'ModelCardExportOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardProcessingStatus' => [ 'type' => 'string', 'enum' => [ 'DeleteInProgress', 'DeletePending', 'ContentDeleted', 'ExportJobsDeleted', 'DeleteCompleted', 'DeleteFailed', ], ], 'ModelCardSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ModelCardSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelCardSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardStatus' => [ 'type' => 'string', 'enum' => [ 'Draft', 'PendingReview', 'Approved', 'Archived', ], ], 'ModelCardSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardSummary', ], ], 'ModelCardVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'Version', ], ], 'ModelCardVersionSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'ModelCardVersion', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardVersionSummary', ], ], 'ModelClientConfig' => [ 'type' => 'structure', 'members' => [ 'InvocationsTimeoutInSeconds' => [ 'shape' => 'InvocationsTimeoutInSeconds', ], 'InvocationsMaxRetries' => [ 'shape' => 'InvocationsMaxRetries', ], ], ], 'ModelCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ModelConfiguration' => [ 'type' => 'structure', 'members' => [ 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameters' => [ 'shape' => 'EnvironmentParameters', ], 'CompilationJobName' => [ 'shape' => 'RecommendationJobCompilationJobName', ], ], ], 'ModelDashboardEndpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'ModelDashboardEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardEndpoint', ], ], 'ModelDashboardIndicatorAction' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'ModelDashboardModel' => [ 'type' => 'structure', 'members' => [ 'Model' => [ 'shape' => 'Model', ], 'Endpoints' => [ 'shape' => 'ModelDashboardEndpoints', ], 'LastBatchTransformJob' => [ 'shape' => 'TransformJob', ], 'MonitoringSchedules' => [ 'shape' => 'ModelDashboardMonitoringSchedules', ], 'ModelCard' => [ 'shape' => 'ModelDashboardModelCard', ], ], ], 'ModelDashboardModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], ], ], 'ModelDashboardMonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], ], ], 'ModelDashboardMonitoringSchedules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardMonitoringSchedule', ], ], 'ModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'S3ModelDataSource', ], ], ], 'ModelDeployConfig' => [ 'type' => 'structure', 'members' => [ 'AutoGenerateEndpointName' => [ 'shape' => 'AutoGenerateEndpointName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDeployResult' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDigests' => [ 'type' => 'structure', 'members' => [ 'ArtifactDigest' => [ 'shape' => 'ArtifactDigest', ], ], ], 'ModelExplainabilityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelExplainabilityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelExplainabilityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelInfrastructureConfig' => [ 'type' => 'structure', 'required' => [ 'InfrastructureType', 'RealTimeInferenceConfig', ], 'members' => [ 'InfrastructureType' => [ 'shape' => 'ModelInfrastructureType', ], 'RealTimeInferenceConfig' => [ 'shape' => 'RealTimeInferenceConfig', ], ], ], 'ModelInfrastructureType' => [ 'type' => 'string', 'enum' => [ 'RealTimeInference', ], ], 'ModelInput' => [ 'type' => 'structure', 'required' => [ 'DataInputConfig', ], 'members' => [ 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'ModelInsightsLocation' => [ 'type' => 'string', 'min' => 1, ], 'ModelLatencyThreshold' => [ 'type' => 'structure', 'members' => [ 'Percentile' => [ 'shape' => 'String64', ], 'ValueInMilliseconds' => [ 'shape' => 'Integer', ], ], ], 'ModelLatencyThresholds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelLatencyThreshold', ], 'max' => 1, 'min' => 1, ], 'ModelMetadataFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'ModelMetadataFilterType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ModelMetadataFilterType' => [ 'type' => 'string', 'enum' => [ 'Domain', 'Framework', 'Task', 'FrameworkVersion', ], ], 'ModelMetadataFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataFilter', ], 'max' => 4, 'min' => 1, ], 'ModelMetadataSearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ModelMetadataFilters', ], ], ], 'ModelMetadataSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataSummary', ], ], 'ModelMetadataSummary' => [ 'type' => 'structure', 'required' => [ 'Domain', 'Framework', 'Task', 'Model', 'FrameworkVersion', ], 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Model' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'String', ], ], ], 'ModelMetrics' => [ 'type' => 'structure', 'members' => [ 'ModelQuality' => [ 'shape' => 'ModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'ModelDataQuality', ], 'Bias' => [ 'shape' => 'Bias', ], 'Explainability' => [ 'shape' => 'Explainability', ], ], ], 'ModelName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'ModelNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'ModelPackage' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], ], ], 'ModelPackageArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-package/.*', ], 'ModelPackageArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageArn', ], 'max' => 100, 'min' => 1, ], 'ModelPackageContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', ], 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageDigest' => [ 'shape' => 'ImageDigest', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelInput' => [ 'shape' => 'ModelInput', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'ModelPackageFrameworkVersion', ], 'NearestModelName' => [ 'shape' => 'String', ], ], ], 'ModelPackageContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageContainerDefinition', ], 'max' => 15, 'min' => 1, ], 'ModelPackageFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'ModelPackageGroup' => [ 'type' => 'structure', 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ModelPackageGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-package-group/.*', ], 'ModelPackageGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', 'DeleteFailed', ], ], 'ModelPackageGroupSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'ModelPackageGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageGroupSummary', ], ], 'ModelPackageSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'ModelPackageStatusDetails' => [ 'type' => 'structure', 'required' => [ 'ValidationStatuses', ], 'members' => [ 'ValidationStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], ], ], 'ModelPackageStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedModelPackageStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'ModelPackageStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageStatusItem', ], ], 'ModelPackageSummaries' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageSummary', ], ], 'ModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'ModelPackageSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageSummary', ], ], 'ModelPackageType' => [ 'type' => 'string', 'enum' => [ 'Versioned', 'Unversioned', 'Both', ], ], 'ModelPackageValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TransformJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'ModelPackageValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageValidationProfile', ], 'max' => 1, 'min' => 1, ], 'ModelPackageValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'ModelPackageValidationProfiles', ], ], ], 'ModelPackageVersion' => [ 'type' => 'integer', 'min' => 1, ], 'ModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'ProblemType' => [ 'shape' => 'MonitoringProblemType', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelQualityJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelRegisterSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'CrossAccountModelRegisterRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'ModelSetupTime' => [ 'type' => 'integer', 'min' => 0, ], 'ModelSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelArn', 'CreationTime', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelSummary', ], ], 'ModelVariantAction' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Remove', 'Promote', ], ], 'ModelVariantActionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelVariantName', ], 'value' => [ 'shape' => 'ModelVariantAction', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], ], ], 'ModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfig', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfigSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', 'Status', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], 'Status' => [ 'shape' => 'ModelVariantStatus', ], ], ], 'ModelVariantConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfigSummary', ], ], 'ModelVariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelVariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'InService', 'Deleting', 'Deleted', ], ], 'MonitoringAlertActions' => [ 'type' => 'structure', 'members' => [ 'ModelDashboardIndicator' => [ 'shape' => 'ModelDashboardIndicatorAction', ], ], ], 'MonitoringAlertHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertHistorySummary', ], ], 'MonitoringAlertHistorySortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', ], ], 'MonitoringAlertHistorySummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'CreationTime', 'AlertStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'MonitoringAlertName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringAlertStatus' => [ 'type' => 'string', 'enum' => [ 'InAlert', 'OK', ], ], 'MonitoringAlertSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringAlertName', 'CreationTime', 'LastModifiedTime', 'AlertStatus', 'DatapointsToAlert', 'EvaluationPeriod', 'Actions', ], 'members' => [ 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], 'Actions' => [ 'shape' => 'MonitoringAlertActions', ], ], ], 'MonitoringAlertSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertSummary', ], 'max' => 100, 'min' => 1, ], 'MonitoringAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'MonitoringClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringConstraintsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 50, 'min' => 1, ], 'MonitoringCsvDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Header' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringDatapointsToAlert' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Csv' => [ 'shape' => 'MonitoringCsvDatasetFormat', ], 'Json' => [ 'shape' => 'MonitoringJsonDatasetFormat', ], 'Parquet' => [ 'shape' => 'MonitoringParquetDatasetFormat', ], ], ], 'MonitoringEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 50, ], 'MonitoringEvaluationPeriod' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringExecutionSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'ScheduledTime', 'Status', ], ], 'MonitoringExecutionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'ScheduledTime', 'CreationTime', 'LastModifiedTime', 'MonitoringExecutionStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringExecutionStatus' => [ 'shape' => 'ExecutionStatus', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringExecutionSummary', ], ], 'MonitoringGroundTruthS3Input' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], ], ], 'MonitoringInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'MonitoringInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringInput', ], 'max' => 1, 'min' => 1, ], 'MonitoringJobDefinition' => [ 'type' => 'structure', 'required' => [ 'MonitoringInputs', 'MonitoringOutputConfig', 'MonitoringResources', 'MonitoringAppSpecification', 'RoleArn', ], 'members' => [ 'BaselineConfig' => [ 'shape' => 'MonitoringBaselineConfig', ], 'MonitoringInputs' => [ 'shape' => 'MonitoringInputs', ], 'MonitoringOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'MonitoringResources' => [ 'shape' => 'MonitoringResources', ], 'MonitoringAppSpecification' => [ 'shape' => 'MonitoringAppSpecification', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'MonitoringJobDefinitionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringJobDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'MonitoringJobDefinitionSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'MonitoringJobDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringJobDefinitionName', 'MonitoringJobDefinitionArn', 'CreationTime', 'EndpointName', ], 'members' => [ 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringJobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'MonitoringJobDefinitionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringJobDefinitionSummary', ], ], 'MonitoringJsonDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Line' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'MonitoringNetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'MonitoringOutput' => [ 'type' => 'structure', 'required' => [ 'S3Output', ], 'members' => [ 'S3Output' => [ 'shape' => 'MonitoringS3Output', ], ], ], 'MonitoringOutputConfig' => [ 'type' => 'structure', 'required' => [ 'MonitoringOutputs', ], 'members' => [ 'MonitoringOutputs' => [ 'shape' => 'MonitoringOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringOutput', ], 'max' => 1, 'min' => 1, ], 'MonitoringParquetDatasetFormat' => [ 'type' => 'structure', 'members' => [], ], 'MonitoringProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'MonitoringResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'MonitoringClusterConfig', ], ], ], 'MonitoringS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', ], 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'MonitoringS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'MonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'MonitoringScheduleArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringScheduleConfig' => [ 'type' => 'structure', 'members' => [ 'ScheduleConfig' => [ 'shape' => 'ScheduleConfig', ], 'MonitoringJobDefinition' => [ 'shape' => 'MonitoringJobDefinition', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringSchedule', ], ], 'MonitoringScheduleName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringScheduleSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'MonitoringScheduleSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleArn', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringScheduleSummary', ], ], 'MonitoringStatisticsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MonitoringMaxRuntimeInSeconds', ], ], ], 'MonitoringTimeOffsetString' => [ 'type' => 'string', 'max' => 15, 'min' => 1, 'pattern' => '^.?P.*', ], 'MonitoringType' => [ 'type' => 'string', 'enum' => [ 'DataQuality', 'ModelQuality', 'ModelBias', 'ModelExplainability', ], ], 'MountPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^\\/.*', ], 'MultiModelConfig' => [ 'type' => 'structure', 'members' => [ 'ModelCacheSetting' => [ 'shape' => 'ModelCacheSetting', ], ], ], 'NameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'NeoVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'NeoVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'NeoVpcSubnets', ], ], ], 'NeoVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'NeoVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'NestedFilters' => [ 'type' => 'structure', 'required' => [ 'NestedPropertyName', 'Filters', ], 'members' => [ 'NestedPropertyName' => [ 'shape' => 'ResourcePropertyName', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'NestedFiltersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NestedFilters', ], 'max' => 20, 'min' => 1, ], 'NetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'NetworkInterfaceId' => [ 'type' => 'string', ], 'NextToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'NotebookInstanceAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'NotebookInstanceAcceleratorTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceAcceleratorType', ], ], 'NotebookInstanceArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'NotebookInstanceLifecycleConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleHook', ], 'max' => 1, ], 'NotebookInstanceLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', 'NotebookInstanceLifecycleConfigArn', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummary', ], ], 'NotebookInstanceLifecycleHook' => [ 'type' => 'structure', 'members' => [ 'Content' => [ 'shape' => 'NotebookInstanceLifecycleConfigContent', ], ], ], 'NotebookInstanceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'NotebookInstanceSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InService', 'Stopping', 'Stopped', 'Failed', 'Deleting', 'Updating', ], ], 'NotebookInstanceSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'NotebookInstanceArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], ], ], 'NotebookInstanceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceSummary', ], ], 'NotebookInstanceUrl' => [ 'type' => 'string', ], 'NotebookInstanceVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'NotebookOutputOption' => [ 'type' => 'string', 'enum' => [ 'Allowed', 'Disabled', ], ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'NotificationTopicArn' => [ 'shape' => 'NotificationTopicArn', ], ], ], 'NotificationTopicArn' => [ 'type' => 'string', 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*', ], 'NumberOfHumanWorkersPerDataObject' => [ 'type' => 'integer', 'max' => 9, 'min' => 1, ], 'NumberOfSteps' => [ 'type' => 'integer', 'min' => 1, ], 'ObjectiveStatus' => [ 'type' => 'string', 'enum' => [ 'Succeeded', 'Pending', 'Failed', ], ], 'ObjectiveStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'ObjectiveStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Succeeded' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Pending' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Failed' => [ 'shape' => 'ObjectiveStatusCounter', ], ], ], 'OfflineStoreConfig' => [ 'type' => 'structure', 'required' => [ 'S3StorageConfig', ], 'members' => [ 'S3StorageConfig' => [ 'shape' => 'S3StorageConfig', ], 'DisableGlueTableCreation' => [ 'shape' => 'Boolean', ], 'DataCatalogConfig' => [ 'shape' => 'DataCatalogConfig', ], 'TableFormat' => [ 'shape' => 'TableFormat', ], ], ], 'OfflineStoreStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'OfflineStoreStatusValue', ], 'BlockedReason' => [ 'shape' => 'BlockedReason', ], ], ], 'OfflineStoreStatusValue' => [ 'type' => 'string', 'enum' => [ 'Active', 'Blocked', 'Disabled', ], ], 'OidcConfig' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'ClientSecret', 'Issuer', 'AuthorizationEndpoint', 'TokenEndpoint', 'UserInfoEndpoint', 'LogoutEndpoint', 'JwksUri', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'ClientSecret' => [ 'shape' => 'ClientSecret', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcConfigForResponse' => [ 'type' => 'structure', 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcEndpoint' => [ 'type' => 'string', 'max' => 500, 'pattern' => 'https://\\S+', ], 'OidcMemberDefinition' => [ 'type' => 'structure', 'required' => [ 'Groups', ], 'members' => [ 'Groups' => [ 'shape' => 'Groups', ], ], ], 'OnlineStoreConfig' => [ 'type' => 'structure', 'members' => [ 'SecurityConfig' => [ 'shape' => 'OnlineStoreSecurityConfig', ], 'EnableOnlineStore' => [ 'shape' => 'Boolean', ], 'TtlDuration' => [ 'shape' => 'TtlDuration', ], ], ], 'OnlineStoreConfigUpdate' => [ 'type' => 'structure', 'members' => [ 'TtlDuration' => [ 'shape' => 'TtlDuration', ], ], ], 'OnlineStoreSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OnlineStoreTotalSizeBytes' => [ 'type' => 'long', ], 'Operator' => [ 'type' => 'string', 'enum' => [ 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqualTo', 'LessThan', 'LessThanOrEqualTo', 'Contains', 'Exists', 'NotExists', 'In', ], ], 'OptionalDouble' => [ 'type' => 'double', ], 'OptionalInteger' => [ 'type' => 'integer', ], 'OptionalVolumeSizeInGB' => [ 'type' => 'integer', 'min' => 0, ], 'OrderKey' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'OutputCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'NONE', ], ], 'OutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'TargetDevice' => [ 'shape' => 'TargetDevice', ], 'TargetPlatform' => [ 'shape' => 'TargetPlatform', ], 'CompilerOptions' => [ 'shape' => 'CompilerOptions', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'OutputCompressionType', ], ], ], 'OutputParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String256', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'OutputParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputParameter', ], 'max' => 50, 'min' => 0, ], 'PaginationToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'ParallelismConfiguration' => [ 'type' => 'structure', 'required' => [ 'MaxParallelExecutionSteps', ], 'members' => [ 'MaxParallelExecutionSteps' => [ 'shape' => 'MaxParallelExecutionSteps', ], ], ], 'Parameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'PipelineParameterName', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'ParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], 'max' => 50, 'min' => 0, ], 'ParameterName' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'ParameterRange' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRangeSpecification' => [ 'shape' => 'IntegerParameterRangeSpecification', ], 'ContinuousParameterRangeSpecification' => [ 'shape' => 'ContinuousParameterRangeSpecification', ], 'CategoricalParameterRangeSpecification' => [ 'shape' => 'CategoricalParameterRangeSpecification', ], ], ], 'ParameterRanges' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRanges' => [ 'shape' => 'IntegerParameterRanges', ], 'ContinuousParameterRanges' => [ 'shape' => 'ContinuousParameterRanges', ], 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameterRanges', ], 'AutoParameters' => [ 'shape' => 'AutoParameters', ], ], ], 'ParameterType' => [ 'type' => 'string', 'enum' => [ 'Integer', 'Continuous', 'Categorical', 'FreeText', ], ], 'ParameterValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterValue', ], 'max' => 30, 'min' => 1, ], 'Parent' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ParentHyperParameterTuningJob' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'ParentHyperParameterTuningJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParentHyperParameterTuningJob', ], 'max' => 5, 'min' => 1, ], 'Parents' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parent', ], ], 'PendingDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'ShadowProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], ], ], 'PendingProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'PendingProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingProductionVariantSummary', ], 'min' => 1, ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, ], 'Phase' => [ 'type' => 'structure', 'members' => [ 'InitialNumberOfUsers' => [ 'shape' => 'InitialNumberOfUsers', ], 'SpawnRate' => [ 'shape' => 'SpawnRate', ], 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], ], ], 'Phases' => [ 'type' => 'list', 'member' => [ 'shape' => 'Phase', ], 'min' => 1, ], 'Pipeline' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*', ], 'PipelineDefinition' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'PipelineDefinitionS3Location' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ObjectKey', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'ObjectKey' => [ 'shape' => 'Key', ], 'VersionId' => [ 'shape' => 'VersionId', ], ], ], 'PipelineDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecution' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'PipelineExecutionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$', ], 'PipelineExecutionDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecutionFailureReason' => [ 'type' => 'string', 'max' => 1300, 'pattern' => '.*', ], 'PipelineExecutionName' => [ 'type' => 'string', 'max' => 82, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}', ], 'PipelineExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'PipelineExecutionStep' => [ 'type' => 'structure', 'members' => [ 'StepName' => [ 'shape' => 'StepName', ], 'StepDisplayName' => [ 'shape' => 'StepDisplayName', ], 'StepDescription' => [ 'shape' => 'StepDescription', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StepStatus' => [ 'shape' => 'StepStatus', ], 'CacheHitResult' => [ 'shape' => 'CacheHitResult', ], 'AttemptCount' => [ 'shape' => 'IntegerValue', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Metadata' => [ 'shape' => 'PipelineExecutionStepMetadata', ], 'SelectiveExecutionResult' => [ 'shape' => 'SelectiveExecutionResult', ], ], ], 'PipelineExecutionStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionStep', ], 'max' => 100, 'min' => 0, ], 'PipelineExecutionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJobStepMetadata', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJobStepMetadata', ], 'TransformJob' => [ 'shape' => 'TransformJobStepMetadata', ], 'TuningJob' => [ 'shape' => 'TuningJobStepMetaData', ], 'Model' => [ 'shape' => 'ModelStepMetadata', ], 'RegisterModel' => [ 'shape' => 'RegisterModelStepMetadata', ], 'Condition' => [ 'shape' => 'ConditionStepMetadata', ], 'Callback' => [ 'shape' => 'CallbackStepMetadata', ], 'Lambda' => [ 'shape' => 'LambdaStepMetadata', ], 'QualityCheck' => [ 'shape' => 'QualityCheckStepMetadata', ], 'ClarifyCheck' => [ 'shape' => 'ClarifyCheckStepMetadata', ], 'EMR' => [ 'shape' => 'EMRStepMetadata', ], 'Fail' => [ 'shape' => 'FailStepMetadata', ], 'AutoMLJob' => [ 'shape' => 'AutoMLJobStepMetadata', ], ], ], 'PipelineExecutionSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionFailureReason' => [ 'shape' => 'String3072', ], ], ], 'PipelineExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionSummary', ], 'max' => 100, 'min' => 0, ], 'PipelineExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'PipelineName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}', ], 'PipelineNameOrArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})', ], 'PipelineParameterName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$', ], 'PipelineStatus' => [ 'type' => 'string', 'enum' => [ 'Active', ], ], 'PipelineSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastExecutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'PipelineSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineSummary', ], 'max' => 100, 'min' => 0, ], 'PlatformIdentifier' => [ 'type' => 'string', 'max' => 15, 'pattern' => '^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2)$', ], 'PolicyString' => [ 'type' => 'string', 'max' => 20480, 'min' => 1, 'pattern' => '.*', ], 'PredefinedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'PredefinedMetricType' => [ 'shape' => 'String', ], ], ], 'PresignedDomainUrl' => [ 'type' => 'string', ], 'ProbabilityThresholdAttribute' => [ 'type' => 'double', ], 'ProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'ProcessingClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingEnvironmentKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'ProcessingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 100, ], 'ProcessingEnvironmentValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\S\\s]*', ], 'ProcessingFeatureStoreOutput' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'ProcessingInput' => [ 'type' => 'structure', 'required' => [ 'InputName', ], 'members' => [ 'InputName' => [ 'shape' => 'String', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], 'S3Input' => [ 'shape' => 'ProcessingS3Input', ], 'DatasetDefinition' => [ 'shape' => 'DatasetDefinition', ], ], ], 'ProcessingInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingInput', ], 'max' => 10, 'min' => 0, ], 'ProcessingInstanceCount' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ProcessingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'ProcessingJob' => [ 'type' => 'structure', 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ProcessingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/.*', ], 'ProcessingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ProcessingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ProcessingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'ProcessingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingJobSummary', ], ], 'ProcessingJobSummary' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingJobArn', 'CreationTime', 'ProcessingJobStatus', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], ], ], 'ProcessingLocalPath' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ProcessingMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 604800, 'min' => 1, ], 'ProcessingOutput' => [ 'type' => 'structure', 'required' => [ 'OutputName', ], 'members' => [ 'OutputName' => [ 'shape' => 'String', ], 'S3Output' => [ 'shape' => 'ProcessingS3Output', ], 'FeatureStoreOutput' => [ 'shape' => 'ProcessingFeatureStoreOutput', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], ], ], 'ProcessingOutputConfig' => [ 'type' => 'structure', 'required' => [ 'Outputs', ], 'members' => [ 'Outputs' => [ 'shape' => 'ProcessingOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingOutput', ], 'max' => 10, 'min' => 0, ], 'ProcessingResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'ProcessingClusterConfig', ], ], ], 'ProcessingS3CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ProcessingS3DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'ProcessingS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', ], ], 'ProcessingS3Input' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3DataType' => [ 'shape' => 'ProcessingS3DataType', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'S3CompressionType' => [ 'shape' => 'ProcessingS3CompressionType', ], ], ], 'ProcessingS3InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'ProcessingS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', 'S3UploadMode', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'ProcessingS3UploadMode' => [ 'type' => 'string', 'enum' => [ 'Continuous', 'EndOfJob', ], ], 'ProcessingStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'ProcessingMaxRuntimeInSeconds', ], ], ], 'ProcessingVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 1, ], 'Processor' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'ProductId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ProductListings' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ProductionVariant' => [ 'type' => 'structure', 'required' => [ 'VariantName', 'ModelName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'InitialInstanceCount' => [ 'shape' => 'InitialTaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialVariantWeight' => [ 'shape' => 'VariantWeight', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'CoreDumpConfig' => [ 'shape' => 'ProductionVariantCoreDumpConfig', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'ProductionVariantVolumeSizeInGB', ], 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], 'EnableSSMAccess' => [ 'shape' => 'ProductionVariantSSMAccess', ], ], ], 'ProductionVariantAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantCoreDumpConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProductionVariantInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.12xlarge', 'ml.m5d.24xlarge', 'ml.c4.large', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.large', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.12xlarge', 'ml.r5.24xlarge', 'ml.r5d.large', 'ml.r5d.xlarge', 'ml.r5d.2xlarge', 'ml.r5d.4xlarge', 'ml.r5d.12xlarge', 'ml.r5d.24xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.p4d.24xlarge', 'ml.c7g.large', 'ml.c7g.xlarge', 'ml.c7g.2xlarge', 'ml.c7g.4xlarge', 'ml.c7g.8xlarge', 'ml.c7g.12xlarge', 'ml.c7g.16xlarge', 'ml.m6g.large', 'ml.m6g.xlarge', 'ml.m6g.2xlarge', 'ml.m6g.4xlarge', 'ml.m6g.8xlarge', 'ml.m6g.12xlarge', 'ml.m6g.16xlarge', 'ml.m6gd.large', 'ml.m6gd.xlarge', 'ml.m6gd.2xlarge', 'ml.m6gd.4xlarge', 'ml.m6gd.8xlarge', 'ml.m6gd.12xlarge', 'ml.m6gd.16xlarge', 'ml.c6g.large', 'ml.c6g.xlarge', 'ml.c6g.2xlarge', 'ml.c6g.4xlarge', 'ml.c6g.8xlarge', 'ml.c6g.12xlarge', 'ml.c6g.16xlarge', 'ml.c6gd.large', 'ml.c6gd.xlarge', 'ml.c6gd.2xlarge', 'ml.c6gd.4xlarge', 'ml.c6gd.8xlarge', 'ml.c6gd.12xlarge', 'ml.c6gd.16xlarge', 'ml.c6gn.large', 'ml.c6gn.xlarge', 'ml.c6gn.2xlarge', 'ml.c6gn.4xlarge', 'ml.c6gn.8xlarge', 'ml.c6gn.12xlarge', 'ml.c6gn.16xlarge', 'ml.r6g.large', 'ml.r6g.xlarge', 'ml.r6g.2xlarge', 'ml.r6g.4xlarge', 'ml.r6g.8xlarge', 'ml.r6g.12xlarge', 'ml.r6g.16xlarge', 'ml.r6gd.large', 'ml.r6gd.xlarge', 'ml.r6gd.2xlarge', 'ml.r6gd.4xlarge', 'ml.r6gd.8xlarge', 'ml.r6gd.12xlarge', 'ml.r6gd.16xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.inf2.xlarge', 'ml.inf2.8xlarge', 'ml.inf2.24xlarge', 'ml.inf2.48xlarge', ], ], 'ProductionVariantList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariant', ], 'max' => 10, 'min' => 1, ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantSSMAccess' => [ 'type' => 'boolean', ], 'ProductionVariantServerlessConfig' => [ 'type' => 'structure', 'required' => [ 'MemorySizeInMB', 'MaxConcurrency', ], 'members' => [ 'MemorySizeInMB' => [ 'shape' => 'ServerlessMemorySizeInMB', ], 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'VariantStatus', ], 'StatusMessage' => [ 'shape' => 'VariantStatusMessage', ], 'StartTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProductionVariantStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantStatus', ], 'max' => 5, 'min' => 0, ], 'ProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'ProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantSummary', ], 'min' => 1, ], 'ProductionVariantVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 512, 'min' => 1, ], 'ProfilerConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'ProfilerRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'ProfilerRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProfilerRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'ProfilingIntervalInMilliseconds' => [ 'type' => 'long', ], 'ProfilingParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'ProfilingStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ProgrammingLang' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'Project' => [ 'type' => 'structure', 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Tags' => [ 'shape' => 'TagList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'ProjectArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:project:.*', ], 'ProjectEntityName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'ProjectId' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'ProjectSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ProjectSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ProjectStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'CreateInProgress', 'CreateCompleted', 'CreateFailed', 'DeleteInProgress', 'DeleteFailed', 'DeleteCompleted', 'UpdateInProgress', 'UpdateCompleted', 'UpdateFailed', ], ], 'ProjectSummary' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ProjectArn', 'ProjectId', 'CreationTime', 'ProjectStatus', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], ], ], 'ProjectSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProjectSummary', ], ], 'PropertyNameHint' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'pattern' => '.*', ], 'PropertyNameQuery' => [ 'type' => 'structure', 'required' => [ 'PropertyNameHint', ], 'members' => [ 'PropertyNameHint' => [ 'shape' => 'PropertyNameHint', ], ], ], 'PropertyNameSuggestion' => [ 'type' => 'structure', 'members' => [ 'PropertyName' => [ 'shape' => 'ResourcePropertyName', ], ], ], 'PropertyNameSuggestionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyNameSuggestion', ], ], 'ProvisionedProductStatusMessage' => [ 'type' => 'string', 'pattern' => '.*', ], 'ProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ProvisioningParameterKey', ], 'Value' => [ 'shape' => 'ProvisioningParameterValue', ], ], ], 'ProvisioningParameterKey' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '.*', ], 'ProvisioningParameterValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningParameter', ], ], 'PublicWorkforceTaskPrice' => [ 'type' => 'structure', 'members' => [ 'AmountInUsd' => [ 'shape' => 'USD', ], ], ], 'PutModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ResourcePolicy', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'PutModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'QualityCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckStatistics' => [ 'shape' => 'String1024', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineStatistics' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'QueryFilters' => [ 'type' => 'structure', 'members' => [ 'Types' => [ 'shape' => 'QueryTypes', ], 'LineageTypes' => [ 'shape' => 'QueryLineageTypes', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedAfter' => [ 'shape' => 'Timestamp', ], 'Properties' => [ 'shape' => 'QueryProperties', ], ], ], 'QueryLineageMaxDepth' => [ 'type' => 'integer', 'max' => 10, ], 'QueryLineageMaxResults' => [ 'type' => 'integer', 'max' => 50, ], 'QueryLineageRequest' => [ 'type' => 'structure', 'members' => [ 'StartArns' => [ 'shape' => 'QueryLineageStartArns', ], 'Direction' => [ 'shape' => 'Direction', ], 'IncludeEdges' => [ 'shape' => 'Boolean', ], 'Filters' => [ 'shape' => 'QueryFilters', ], 'MaxDepth' => [ 'shape' => 'QueryLineageMaxDepth', ], 'MaxResults' => [ 'shape' => 'QueryLineageMaxResults', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageResponse' => [ 'type' => 'structure', 'members' => [ 'Vertices' => [ 'shape' => 'Vertices', ], 'Edges' => [ 'shape' => 'Edges', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageStartArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationEntityArn', ], 'max' => 1, 'min' => 0, ], 'QueryLineageTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageType', ], 'max' => 4, ], 'QueryProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'String256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 5, ], 'QueryTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String40', ], 'max' => 5, ], 'RSessionAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], ], ], 'RStudioServerProAccessStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'RStudioServerProAppSettings' => [ 'type' => 'structure', 'members' => [ 'AccessStatus' => [ 'shape' => 'RStudioServerProAccessStatus', ], 'UserGroup' => [ 'shape' => 'RStudioServerProUserGroup', ], ], ], 'RStudioServerProDomainSettings' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], ], ], 'RStudioServerProUserGroup' => [ 'type' => 'string', 'enum' => [ 'R_STUDIO_ADMIN', 'R_STUDIO_USER', ], ], 'RandomSeed' => [ 'type' => 'integer', 'min' => 0, ], 'RealTimeInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'TaskCount', ], ], ], 'RealTimeInferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationId', 'InstanceType', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'RealTimeInferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeInferenceRecommendation', ], 'max' => 3, 'min' => 0, ], 'RealtimeInferenceInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantInstanceType', ], ], 'RecommendationFailureReason' => [ 'type' => 'string', ], 'RecommendationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/.*', ], 'RecommendationJobCompilationJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'RecommendationJobCompiledOutputConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputUri' => [ 'shape' => 'S3Uri', ], ], ], 'RecommendationJobContainerConfig' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'String', ], 'PayloadConfig' => [ 'shape' => 'RecommendationJobPayloadConfig', ], 'NearestModelName' => [ 'shape' => 'String', ], 'SupportedInstanceTypes' => [ 'shape' => 'RecommendationJobSupportedInstanceTypes', ], 'DataInputConfig' => [ 'shape' => 'RecommendationJobDataInputConfig', ], 'SupportedEndpointType' => [ 'shape' => 'RecommendationJobSupportedEndpointType', ], ], ], 'RecommendationJobDataInputConfig' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'RecommendationJobDescription' => [ 'type' => 'string', 'max' => 128, ], 'RecommendationJobInferenceBenchmark' => [ 'type' => 'structure', 'required' => [ 'ModelConfiguration', ], 'members' => [ 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'FailureReason' => [ 'shape' => 'RecommendationFailureReason', ], 'EndpointMetrics' => [ 'shape' => 'InferenceMetrics', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'RecommendationJobInputConfig' => [ 'type' => 'structure', 'members' => [ 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'JobDurationInSeconds' => [ 'shape' => 'JobDurationInSeconds', ], 'TrafficPattern' => [ 'shape' => 'TrafficPattern', ], 'ResourceLimit' => [ 'shape' => 'RecommendationJobResourceLimit', ], 'EndpointConfigurations' => [ 'shape' => 'EndpointInputConfigurations', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ContainerConfig' => [ 'shape' => 'RecommendationJobContainerConfig', ], 'Endpoints' => [ 'shape' => 'Endpoints', ], 'VpcConfig' => [ 'shape' => 'RecommendationJobVpcConfig', ], 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'RecommendationJobName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'RecommendationJobOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CompiledOutputConfig' => [ 'shape' => 'RecommendationJobCompiledOutputConfig', ], ], ], 'RecommendationJobPayloadConfig' => [ 'type' => 'structure', 'members' => [ 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'SupportedContentTypes' => [ 'shape' => 'RecommendationJobSupportedContentTypes', ], ], ], 'RecommendationJobResourceLimit' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTests' => [ 'shape' => 'MaxNumberOfTests', ], 'MaxParallelOfTests' => [ 'shape' => 'MaxParallelOfTests', ], ], ], 'RecommendationJobStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'RecommendationJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatencyThresholds' => [ 'shape' => 'ModelLatencyThresholds', ], 'FlatInvocations' => [ 'shape' => 'FlatInvocations', ], ], ], 'RecommendationJobSupportedContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RecommendationJobSupportedEndpointType' => [ 'type' => 'string', 'enum' => [ 'RealTime', 'Serverless', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RecommendationJobType' => [ 'type' => 'string', 'enum' => [ 'Default', 'Advanced', ], ], 'RecommendationJobVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'RecommendationJobVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'RecommendationJobVpcSubnets', ], ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'RecommendationJobVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'RecommendationMetrics' => [ 'type' => 'structure', 'required' => [ 'CostPerHour', 'CostPerInference', 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'CostPerHour' => [ 'shape' => 'Float', ], 'CostPerInference' => [ 'shape' => 'Float', ], 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], 'CpuUtilization' => [ 'shape' => 'UtilizationMetric', ], 'MemoryUtilization' => [ 'shape' => 'UtilizationMetric', ], 'ModelSetupTime' => [ 'shape' => 'ModelSetupTime', ], ], ], 'RecommendationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'NOT_APPLICABLE', ], ], 'RecommendationStepType' => [ 'type' => 'string', 'enum' => [ 'BENCHMARK', ], ], 'RecordWrapper' => [ 'type' => 'string', 'enum' => [ 'None', 'RecordIO', ], ], 'RedshiftClusterId' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatabase' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'Database', 'DbUser', 'QueryString', 'ClusterRoleArn', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'ClusterId' => [ 'shape' => 'RedshiftClusterId', ], 'Database' => [ 'shape' => 'RedshiftDatabase', ], 'DbUser' => [ 'shape' => 'RedshiftUserName', ], 'QueryString' => [ 'shape' => 'RedshiftQueryString', ], 'ClusterRoleArn' => [ 'shape' => 'RoleArn', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'RedshiftResultFormat', ], 'OutputCompression' => [ 'shape' => 'RedshiftResultCompressionType', ], ], ], 'RedshiftQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'RedshiftResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'GZIP', 'BZIP2', 'ZSTD', 'SNAPPY', ], ], 'RedshiftResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'CSV', ], ], 'RedshiftUserName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'RegisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RegisterModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ReleaseNotes' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'RenderUiTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'Task', 'RoleArn', ], 'members' => [ 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Task' => [ 'shape' => 'RenderableTask', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'RenderUiTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'RenderedContent', 'Errors', ], 'members' => [ 'RenderedContent' => [ 'shape' => 'String', ], 'Errors' => [ 'shape' => 'RenderingErrorList', ], ], ], 'RenderableTask' => [ 'type' => 'structure', 'required' => [ 'Input', ], 'members' => [ 'Input' => [ 'shape' => 'TaskInput', ], ], ], 'RenderingError' => [ 'type' => 'structure', 'required' => [ 'Code', 'Message', ], 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'RenderingErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RenderingError', ], ], 'RepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'RepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryCredentialsProviderArn', ], 'members' => [ 'RepositoryCredentialsProviderArn' => [ 'shape' => 'RepositoryCredentialsProviderArn', ], ], ], 'RepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'RepositoryUrl' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$', ], 'ResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+', ], 'ResourceCatalog' => [ 'type' => 'structure', 'required' => [ 'ResourceCatalogArn', 'ResourceCatalogName', 'Description', 'CreationTime', ], 'members' => [ 'ResourceCatalogArn' => [ 'shape' => 'ResourceCatalogArn', ], 'ResourceCatalogName' => [ 'shape' => 'ResourceCatalogName', ], 'Description' => [ 'shape' => 'ResourceCatalogDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ResourceCatalogArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:sagemaker-catalog/.*', ], 'ResourceCatalogDescription' => [ 'type' => 'string', 'max' => 256, ], 'ResourceCatalogList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceCatalog', ], ], 'ResourceCatalogName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ResourceCatalogSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ResourceCatalogSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ResourceConfig' => [ 'type' => 'structure', 'required' => [ 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroups', ], 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], ], ], 'ResourceConfigForUpdate' => [ 'type' => 'structure', 'required' => [ 'KeepAlivePeriodInSeconds', ], 'members' => [ 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], ], ], 'ResourceId' => [ 'type' => 'string', 'max' => 32, ], 'ResourceInUse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimits' => [ 'type' => 'structure', 'required' => [ 'MaxParallelTrainingJobs', ], 'members' => [ 'MaxNumberOfTrainingJobs' => [ 'shape' => 'MaxNumberOfTrainingJobs', ], 'MaxParallelTrainingJobs' => [ 'shape' => 'MaxParallelTrainingJobs', ], 'MaxRuntimeInSeconds' => [ 'shape' => 'HyperParameterTuningMaxRuntimeInSeconds', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourcePolicyString' => [ 'type' => 'string', 'max' => 20480, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'ResourcePropertyName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'ResourceSpec' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageArn' => [ 'shape' => 'ImageArn', ], 'SageMakerImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'InstanceType' => [ 'shape' => 'AppInstanceType', ], 'LifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'TrainingJob', 'Experiment', 'ExperimentTrial', 'ExperimentTrialComponent', 'Endpoint', 'ModelPackage', 'ModelPackageGroup', 'Pipeline', 'PipelineExecution', 'FeatureGroup', 'Project', 'FeatureMetadata', 'HyperParameterTuningJob', 'ModelCard', 'Model', ], ], 'ResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'ResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResponseMIMEType', ], ], 'RetentionPolicy' => [ 'type' => 'structure', 'members' => [ 'HomeEfsFileSystem' => [ 'shape' => 'RetentionType', ], ], ], 'RetentionType' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Delete', ], ], 'RetryPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'RetryPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'RetryStrategy' => [ 'type' => 'structure', 'required' => [ 'MaximumRetryAttempts', ], 'members' => [ 'MaximumRetryAttempts' => [ 'shape' => 'MaximumRetryAttempts', ], ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'RollingUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'MaximumBatchSize', 'WaitIntervalInSeconds', ], 'members' => [ 'MaximumBatchSize' => [ 'shape' => 'CapacitySize', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], 'RollbackMaximumBatchSize' => [ 'shape' => 'CapacitySize', ], ], ], 'RootAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'RuleConfigurationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'RuleEvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'NoIssuesFound', 'IssuesFound', 'Error', 'Stopping', 'Stopped', ], ], 'RuleParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 100, 'min' => 0, ], 'S3DataDistribution' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'S3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'S3DataDistributionType' => [ 'shape' => 'S3DataDistribution', ], 'AttributeNames' => [ 'shape' => 'AttributeNames', ], 'InstanceGroupNames' => [ 'shape' => 'InstanceGroupNames', ], ], ], 'S3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'S3ModelDataSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', 'CompressionType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3ModelUri', ], 'S3DataType' => [ 'shape' => 'S3ModelDataType', ], 'CompressionType' => [ 'shape' => 'ModelCompressionType', ], ], ], 'S3ModelDataType' => [ 'type' => 'string', 'enum' => [ 'S3Prefix', 'S3Object', ], ], 'S3ModelUri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3OutputPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3StorageConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ResolvedOutputS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'SageMakerImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(?!^[.-])^([a-zA-Z0-9-_.]+)$', ], 'SageMakerImageVersionAliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], 'SagemakerServicecatalogStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'SampleWeightAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_-]+$', ], 'SamplingPercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ScalingPolicies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScalingPolicy', ], ], 'ScalingPolicy' => [ 'type' => 'structure', 'members' => [ 'TargetTracking' => [ 'shape' => 'TargetTrackingScalingPolicyConfiguration', ], ], 'union' => true, ], 'ScalingPolicyMetric' => [ 'type' => 'structure', 'members' => [ 'InvocationsPerInstance' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'ScalingPolicyObjective' => [ 'type' => 'structure', 'members' => [ 'MinInvocationsPerMinute' => [ 'shape' => 'Integer', ], 'MaxInvocationsPerMinute' => [ 'shape' => 'Integer', ], ], ], 'ScheduleConfig' => [ 'type' => 'structure', 'required' => [ 'ScheduleExpression', ], 'members' => [ 'ScheduleExpression' => [ 'shape' => 'ScheduleExpression', ], ], ], 'ScheduleExpression' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ScheduleStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Failed', 'Scheduled', 'Stopped', ], ], 'SearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'NestedFilters' => [ 'shape' => 'NestedFiltersList', ], 'SubExpressions' => [ 'shape' => 'SearchExpressionList', ], 'Operator' => [ 'shape' => 'BooleanOperator', ], ], ], 'SearchExpressionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchExpression', ], 'max' => 20, 'min' => 1, ], 'SearchRecord' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'Experiment' => [ 'shape' => 'Experiment', ], 'Trial' => [ 'shape' => 'Trial', ], 'TrialComponent' => [ 'shape' => 'TrialComponent', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ModelPackage' => [ 'shape' => 'ModelPackage', ], 'ModelPackageGroup' => [ 'shape' => 'ModelPackageGroup', ], 'Pipeline' => [ 'shape' => 'Pipeline', ], 'PipelineExecution' => [ 'shape' => 'PipelineExecution', ], 'FeatureGroup' => [ 'shape' => 'FeatureGroup', ], 'Project' => [ 'shape' => 'Project', ], 'FeatureMetadata' => [ 'shape' => 'FeatureMetadata', ], 'HyperParameterTuningJob' => [ 'shape' => 'HyperParameterTuningJobSearchEntity', ], 'Model' => [ 'shape' => 'ModelDashboardModel', ], 'ModelCard' => [ 'shape' => 'ModelCard', ], ], ], 'SearchRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SearchExpression' => [ 'shape' => 'SearchExpression', ], 'SortBy' => [ 'shape' => 'ResourcePropertyName', ], 'SortOrder' => [ 'shape' => 'SearchSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CrossAccountFilterOption' => [ 'shape' => 'CrossAccountFilterOption', ], ], ], 'SearchResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'SearchResultsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SearchResultsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchRecord', ], ], 'SearchSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'LaunchingMLInstances', 'PreparingTrainingStack', 'Downloading', 'DownloadingTrainingImage', 'Training', 'Uploading', 'Stopping', 'Stopped', 'MaxRuntimeExceeded', 'Completed', 'Failed', 'Interrupted', 'MaxWaitTimeExceeded', 'Updating', 'Restarting', ], ], 'SecondaryStatusTransition' => [ 'type' => 'structure', 'required' => [ 'Status', 'StartTime', ], 'members' => [ 'Status' => [ 'shape' => 'SecondaryStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'SecondaryStatusTransitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecondaryStatusTransition', ], ], 'SecretArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*', ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, ], 'Seed' => [ 'type' => 'long', ], 'SelectedStep' => [ 'type' => 'structure', 'required' => [ 'StepName', ], 'members' => [ 'StepName' => [ 'shape' => 'String256', ], ], ], 'SelectedStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectedStep', ], 'max' => 50, 'min' => 1, ], 'SelectiveExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'SourcePipelineExecutionArn', 'SelectedSteps', ], 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'SelectedSteps' => [ 'shape' => 'SelectedStepList', ], ], ], 'SelectiveExecutionResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'FailureReason' => [ 'shape' => 'String256', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepFailureResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'ServerlessMaxConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServerlessMemorySizeInMB' => [ 'type' => 'integer', 'max' => 6144, 'min' => 1024, ], 'ServerlessProvisionedConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServiceCatalogEntityId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-]*', ], 'ServiceCatalogProvisionedProductDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisionedProductStatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], ], ], 'ServiceCatalogProvisioningDetails' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'ProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'PathId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'SessionExpirationDurationInSeconds' => [ 'type' => 'integer', 'max' => 43200, 'min' => 1800, ], 'ShadowModeConfig' => [ 'type' => 'structure', 'required' => [ 'SourceModelVariantName', 'ShadowModelVariants', ], 'members' => [ 'SourceModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'ShadowModelVariants' => [ 'shape' => 'ShadowModelVariantConfigList', ], ], ], 'ShadowModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ShadowModelVariantName', 'SamplingPercentage', ], 'members' => [ 'ShadowModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'SamplingPercentage' => [ 'shape' => 'Percentage', ], ], ], 'ShadowModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShadowModelVariantConfig', ], 'max' => 1, 'min' => 1, ], 'SharingSettings' => [ 'type' => 'structure', 'members' => [ 'NotebookOutputOption' => [ 'shape' => 'NotebookOutputOption', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ShuffleConfig' => [ 'type' => 'structure', 'required' => [ 'Seed', ], 'members' => [ 'Seed' => [ 'shape' => 'Seed', ], ], ], 'SingleSignOnUserIdentifier' => [ 'type' => 'string', 'pattern' => 'UserName', ], 'SnsTopicArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]+', ], 'SortActionsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortArtifactsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'SortAssociationsBy' => [ 'type' => 'string', 'enum' => [ 'SourceArn', 'DestinationArn', 'SourceType', 'DestinationType', 'CreationTime', ], ], 'SortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortContextsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortInferenceExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortLineageGroupsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SortPipelineExecutionsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'PipelineExecutionArn', ], ], 'SortPipelinesBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialComponentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SourceAlgorithm' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'ModelDataUrl' => [ 'shape' => 'Url', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'SourceAlgorithmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceAlgorithm', ], 'max' => 1, 'min' => 1, ], 'SourceAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'SourceAlgorithms', ], 'members' => [ 'SourceAlgorithms' => [ 'shape' => 'SourceAlgorithmList', ], ], ], 'SourceIpConfig' => [ 'type' => 'structure', 'required' => [ 'Cidrs', ], 'members' => [ 'Cidrs' => [ 'shape' => 'Cidrs', ], ], ], 'SourceType' => [ 'type' => 'string', 'max' => 128, ], 'SourceUri' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'SpaceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/.*', ], 'SpaceDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'SpaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpaceDetails', ], ], 'SpaceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'SpaceSettings' => [ 'type' => 'structure', 'members' => [ 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], ], ], 'SpaceSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'SpaceStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'SpawnRate' => [ 'type' => 'integer', 'min' => 0, ], 'SplitType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', 'RecordIO', 'TFRecord', ], ], 'StageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'READYTODEPLOY', 'STARTING', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'Stairs' => [ 'type' => 'structure', 'members' => [ 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], 'NumberOfSteps' => [ 'shape' => 'NumberOfSteps', ], 'UsersPerStep' => [ 'shape' => 'UsersPerStep', ], ], ], 'StartEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StartInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'StartInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StartMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StartNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StartPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'StartPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'Statistic' => [ 'type' => 'string', 'enum' => [ 'Average', 'Minimum', 'Maximum', 'SampleCount', 'Sum', ], ], 'StatusDetails' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'StatusMessage' => [ 'type' => 'string', ], 'StepDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'StepDisplayName' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'StepName' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'StepStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'StopAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'StopCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'StopInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'ModelVariantActions', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'ModelVariantActions' => [ 'shape' => 'ModelVariantActionMap', ], 'DesiredModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DesiredState' => [ 'shape' => 'InferenceExperimentStopDesiredState', ], 'Reason' => [ 'shape' => 'InferenceExperimentStatusReason', ], ], ], 'StopInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StopInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'StopLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'StopMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StopNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StopPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'StopPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'StopProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'StopTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'StopTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'StoppingCondition' => [ 'type' => 'structure', 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MaxRuntimeInSeconds', ], 'MaxWaitTimeInSeconds' => [ 'shape' => 'MaxWaitTimeInSeconds', ], ], ], 'String' => [ 'type' => 'string', ], 'String1024' => [ 'type' => 'string', 'max' => 1024, ], 'String128' => [ 'type' => 'string', 'max' => 128, ], 'String200' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '.+', ], 'String2048' => [ 'type' => 'string', 'max' => 2048, ], 'String256' => [ 'type' => 'string', 'max' => 256, ], 'String3072' => [ 'type' => 'string', 'max' => 3072, ], 'String40' => [ 'type' => 'string', 'max' => 40, ], 'String64' => [ 'type' => 'string', 'max' => 64, ], 'String8192' => [ 'type' => 'string', 'max' => 8192, ], 'StringParameterValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'StudioLifecycleConfigAppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', ], ], 'StudioLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*', ], 'StudioLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'StudioLifecycleConfigDetails' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'StudioLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'StudioLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'StudioLifecycleConfigsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigDetails', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'Subnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 16, 'min' => 1, ], 'SubscribedWorkteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MarketplaceTitle' => [ 'shape' => 'String200', ], 'SellerName' => [ 'shape' => 'String', ], 'MarketplaceDescription' => [ 'shape' => 'String200', ], 'ListingId' => [ 'shape' => 'String', ], ], ], 'SubscribedWorkteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubscribedWorkteam', ], ], 'Success' => [ 'type' => 'boolean', ], 'SuggestionQuery' => [ 'type' => 'structure', 'members' => [ 'PropertyNameQuery' => [ 'shape' => 'PropertyNameQuery', ], ], ], 'TableFormat' => [ 'type' => 'string', 'enum' => [ 'Glue', 'Iceberg', ], ], 'TableName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'TabularJobConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'CandidateGenerationConfig' => [ 'shape' => 'CandidateGenerationConfig', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'TabularResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'ProblemType' => [ 'shape' => 'ProblemType', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TargetAttributeName' => [ 'type' => 'string', 'min' => 1, ], 'TargetDevice' => [ 'type' => 'string', 'enum' => [ 'lambda', 'ml_m4', 'ml_m5', 'ml_c4', 'ml_c5', 'ml_p2', 'ml_p3', 'ml_g4dn', 'ml_inf1', 'ml_inf2', 'ml_trn1', 'ml_eia2', 'jetson_tx1', 'jetson_tx2', 'jetson_nano', 'jetson_xavier', 'rasp3b', 'imx8qm', 'deeplens', 'rk3399', 'rk3288', 'aisage', 'sbe_c', 'qcs605', 'qcs603', 'sitara_am57x', 'amba_cv2', 'amba_cv22', 'amba_cv25', 'x86_win32', 'x86_win64', 'coreml', 'jacinto_tda4vm', 'imx8mplus', ], ], 'TargetLabelColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TargetObjectiveMetricValue' => [ 'type' => 'float', ], 'TargetPlatform' => [ 'type' => 'structure', 'required' => [ 'Os', 'Arch', ], 'members' => [ 'Os' => [ 'shape' => 'TargetPlatformOs', ], 'Arch' => [ 'shape' => 'TargetPlatformArch', ], 'Accelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], ], ], 'TargetPlatformAccelerator' => [ 'type' => 'string', 'enum' => [ 'INTEL_GRAPHICS', 'MALI', 'NVIDIA', 'NNA', ], ], 'TargetPlatformArch' => [ 'type' => 'string', 'enum' => [ 'X86_64', 'X86', 'ARM64', 'ARM_EABI', 'ARM_EABIHF', ], ], 'TargetPlatformOs' => [ 'type' => 'string', 'enum' => [ 'ANDROID', 'LINUX', ], ], 'TargetTrackingScalingPolicyConfiguration' => [ 'type' => 'structure', 'members' => [ 'MetricSpecification' => [ 'shape' => 'MetricSpecification', ], 'TargetValue' => [ 'shape' => 'Double', ], ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 60, ], 'TaskCount' => [ 'type' => 'integer', 'min' => 0, ], 'TaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'TaskInput' => [ 'type' => 'string', 'max' => 128000, 'min' => 2, 'pattern' => '[\\S\\s]+', ], 'TaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'TaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskKeyword', ], 'max' => 5, 'min' => 1, ], 'TaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'TaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'TemplateContent' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'TemplateContentSha256' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, ], 'TemplateUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TensorBoardAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'TensorBoardOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'TenthFractionsOfACent' => [ 'type' => 'integer', 'max' => 9, 'min' => 0, ], 'TerminationWaitInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'TextClassificationJobConfig' => [ 'type' => 'structure', 'required' => [ 'ContentColumn', 'TargetLabelColumn', ], 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ContentColumn' => [ 'shape' => 'ContentColumn', ], 'TargetLabelColumn' => [ 'shape' => 'TargetLabelColumn', ], ], ], 'ThingName' => [ 'type' => 'string', 'max' => 128, 'pattern' => '[a-zA-Z0-9:_-]+', ], 'TimeSeriesConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', 'TimestampAttributeName', 'ItemIdentifierAttributeName', ], 'members' => [ 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'TimestampAttributeName' => [ 'shape' => 'TimestampAttributeName', ], 'ItemIdentifierAttributeName' => [ 'shape' => 'ItemIdentifierAttributeName', ], 'GroupingAttributeNames' => [ 'shape' => 'GroupingAttributeNames', ], ], ], 'TimeSeriesForecastingJobConfig' => [ 'type' => 'structure', 'required' => [ 'ForecastFrequency', 'ForecastHorizon', 'TimeSeriesConfig', ], 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ForecastFrequency' => [ 'shape' => 'ForecastFrequency', ], 'ForecastHorizon' => [ 'shape' => 'ForecastHorizon', ], 'ForecastQuantiles' => [ 'shape' => 'ForecastQuantiles', ], 'Transformations' => [ 'shape' => 'TimeSeriesTransformations', ], 'TimeSeriesConfig' => [ 'shape' => 'TimeSeriesConfig', ], ], ], 'TimeSeriesForecastingSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'AmazonForecastRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'TimeSeriesTransformations' => [ 'type' => 'structure', 'members' => [ 'Filling' => [ 'shape' => 'FillingTransformations', ], 'Aggregation' => [ 'shape' => 'AggregationTransformations', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TimestampAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TrafficDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TrafficPattern' => [ 'type' => 'structure', 'members' => [ 'TrafficType' => [ 'shape' => 'TrafficType', ], 'Phases' => [ 'shape' => 'Phases', ], 'Stairs' => [ 'shape' => 'Stairs', ], ], ], 'TrafficRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'Type', 'WaitIntervalInSeconds', ], 'members' => [ 'Type' => [ 'shape' => 'TrafficRoutingConfigType', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'CanarySize' => [ 'shape' => 'CapacitySize', ], 'LinearStepSize' => [ 'shape' => 'CapacitySize', ], ], ], 'TrafficRoutingConfigType' => [ 'type' => 'string', 'enum' => [ 'ALL_AT_ONCE', 'CANARY', 'LINEAR', ], ], 'TrafficType' => [ 'type' => 'string', 'enum' => [ 'PHASES', 'STAIRS', ], ], 'TrainingContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerArgument', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerEntrypointString', ], 'max' => 10, 'min' => 1, ], 'TrainingContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'TrainingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrainingEnvironmentKey', ], 'value' => [ 'shape' => 'TrainingEnvironmentValue', ], 'max' => 48, ], 'TrainingEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'TrainingImageConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryAccessMode', ], 'members' => [ 'TrainingRepositoryAccessMode' => [ 'shape' => 'TrainingRepositoryAccessMode', ], 'TrainingRepositoryAuthConfig' => [ 'shape' => 'TrainingRepositoryAuthConfig', ], ], ], 'TrainingInputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', 'FastFile', ], ], 'TrainingInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.p4d.24xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5n.xlarge', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', ], ], 'TrainingInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInstanceType', ], ], 'TrainingJob' => [ 'type' => 'structure', 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TrainingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/.*', ], 'TrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', 'InputDataConfig', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], ], ], 'TrainingJobEarlyStoppingType' => [ 'type' => 'string', 'enum' => [ 'Off', 'Auto', ], ], 'TrainingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TrainingJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'TrainingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrainingJobStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingJobStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Completed' => [ 'shape' => 'TrainingJobStatusCounter', ], 'InProgress' => [ 'shape' => 'TrainingJobStatusCounter', ], 'RetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'NonRetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'Stopped' => [ 'shape' => 'TrainingJobStatusCounter', ], ], ], 'TrainingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'TrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingJobSummary', ], ], 'TrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], ], ], 'TrainingRepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'TrainingRepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryCredentialsProviderArn', ], 'members' => [ 'TrainingRepositoryCredentialsProviderArn' => [ 'shape' => 'TrainingRepositoryCredentialsProviderArn', ], ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:.*', ], 'TrainingSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingImage', 'SupportedTrainingInstanceTypes', 'TrainingChannels', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'ContainerImage', ], 'TrainingImageDigest' => [ 'shape' => 'ImageDigest', ], 'SupportedHyperParameters' => [ 'shape' => 'HyperParameterSpecifications', ], 'SupportedTrainingInstanceTypes' => [ 'shape' => 'TrainingInstanceTypes', ], 'SupportsDistributedTraining' => [ 'shape' => 'Boolean', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'TrainingChannels' => [ 'shape' => 'ChannelSpecifications', ], 'SupportedTuningJobObjectiveMetrics' => [ 'shape' => 'HyperParameterTuningJobObjectives', ], ], ], 'TrainingTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TransformDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'TransformS3DataSource', ], ], ], 'TransformEnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]{0,1023}', ], 'TransformEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformEnvironmentKey', ], 'value' => [ 'shape' => 'TransformEnvironmentValue', ], 'max' => 16, ], 'TransformEnvironmentValue' => [ 'type' => 'string', 'max' => 10240, 'pattern' => '[\\S\\s]*', ], 'TransformInput' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'TransformDataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'SplitType' => [ 'shape' => 'SplitType', ], ], ], 'TransformInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'TransformInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'TransformInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformInstanceType', ], 'min' => 1, ], 'TransformJob' => [ 'type' => 'structure', 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TransformJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*', ], 'TransformJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], ], ], 'TransformJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TransformJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TransformJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TransformJobArn', ], ], ], 'TransformJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformJobSummary', ], ], 'TransformJobSummary' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'CreationTime', 'TransformJobStatus', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'TransformOutput' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'Accept' => [ 'shape' => 'Accept', ], 'AssembleWith' => [ 'shape' => 'AssemblyType', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformResources' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TransformInstanceType', ], 'InstanceCount' => [ 'shape' => 'TransformInstanceCount', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'TransformationAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Trial' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSimpleSummaries', ], ], ], 'TrialArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/.*', ], 'TrialComponent' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'SourceDetail' => [ 'shape' => 'TrialComponentSourceDetail', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'Parents' => [ 'shape' => 'Parents', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'TrialComponentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/.*', ], 'TrialComponentArtifact' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'MediaType' => [ 'shape' => 'MediaType', ], 'Value' => [ 'shape' => 'TrialComponentArtifactValue', ], ], ], 'TrialComponentArtifactValue' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'TrialComponentArtifacts' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey64', ], 'value' => [ 'shape' => 'TrialComponentArtifact', ], 'max' => 30, ], 'TrialComponentKey256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrialComponentKey64' => [ 'type' => 'string', 'max' => 64, 'pattern' => '.*', ], 'TrialComponentMetricSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentMetricSummary', ], ], 'TrialComponentMetricSummary' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TimeStamp' => [ 'shape' => 'Timestamp', ], 'Max' => [ 'shape' => 'OptionalDouble', ], 'Min' => [ 'shape' => 'OptionalDouble', ], 'Last' => [ 'shape' => 'OptionalDouble', ], 'Count' => [ 'shape' => 'OptionalInteger', ], 'Avg' => [ 'shape' => 'OptionalDouble', ], 'StdDev' => [ 'shape' => 'OptionalDouble', ], ], ], 'TrialComponentParameterValue' => [ 'type' => 'structure', 'members' => [ 'StringValue' => [ 'shape' => 'StringParameterValue', ], 'NumberValue' => [ 'shape' => 'DoubleParameterValue', ], ], ], 'TrialComponentParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey256', ], 'value' => [ 'shape' => 'TrialComponentParameterValue', ], 'max' => 150, ], 'TrialComponentPrimaryStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrialComponentSimpleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSimpleSummary', ], ], 'TrialComponentSimpleSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialComponentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialComponentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialComponentSourceDetail' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJob', ], 'TransformJob' => [ 'shape' => 'TransformJob', ], ], ], 'TrialComponentSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSource', ], ], 'TrialComponentStatus' => [ 'type' => 'structure', 'members' => [ 'PrimaryStatus' => [ 'shape' => 'TrialComponentPrimaryStatus', ], 'Message' => [ 'shape' => 'TrialComponentStatusMessage', ], ], ], 'TrialComponentStatusMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'TrialComponentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSummary', ], ], 'TrialComponentSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialSummary', ], ], 'TrialSummary' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialSource' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TtlDuration' => [ 'type' => 'structure', 'members' => [ 'Unit' => [ 'shape' => 'TtlDurationUnit', ], 'Value' => [ 'shape' => 'TtlDurationValue', ], ], ], 'TtlDurationUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', ], ], 'TtlDurationValue' => [ 'type' => 'integer', 'min' => 1, ], 'TuningJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'TargetObjectiveMetricValue' => [ 'shape' => 'TargetObjectiveMetricValue', ], 'BestObjectiveNotImproving' => [ 'shape' => 'BestObjectiveNotImproving', ], 'ConvergenceDetected' => [ 'shape' => 'ConvergenceDetected', ], ], ], 'TuningJobStepMetaData' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'USD' => [ 'type' => 'structure', 'members' => [ 'Dollars' => [ 'shape' => 'Dollars', ], 'Cents' => [ 'shape' => 'Cents', ], 'TenthFractionsOfACent' => [ 'shape' => 'TenthFractionsOfACent', ], ], ], 'UiConfig' => [ 'type' => 'structure', 'members' => [ 'UiTemplateS3Uri' => [ 'shape' => 'S3Uri', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'UiTemplate' => [ 'type' => 'structure', 'required' => [ 'Content', ], 'members' => [ 'Content' => [ 'shape' => 'TemplateContent', ], ], ], 'UiTemplateInfo' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'TemplateUrl', ], 'ContentSha256' => [ 'shape' => 'TemplateContentSha256', ], ], ], 'UpdateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'UpdateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], ], ], 'UpdateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'UpdateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'UpdateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfigForUpdate', ], ], ], 'UpdateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'UpdateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'UpdateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'UpdateDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], ], ], 'UpdateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettingsForUpdate' => [ 'shape' => 'DomainSettingsForUpdate', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], ], ], 'UpdateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], ], ], 'UpdateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'RetainAllVariantProperties' => [ 'shape' => 'Boolean', ], 'ExcludeRetainedVariantProperties' => [ 'shape' => 'VariantPropertyList', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'RetainDeploymentConfig' => [ 'shape' => 'Boolean', ], ], ], 'UpdateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'DesiredWeightsAndCapacities', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'DesiredWeightsAndCapacities' => [ 'shape' => 'DesiredWeightAndCapacityList', ], ], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], ], ], 'UpdateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'UpdateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureAdditions' => [ 'shape' => 'FeatureAdditions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfigUpdate', ], ], ], 'UpdateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'UpdateFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'ParameterAdditions' => [ 'shape' => 'FeatureParameterAdditions', ], 'ParameterRemovals' => [ 'shape' => 'FeatureParameterRemovals', ], ], ], 'UpdateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], ], ], 'UpdateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'UpdateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'DeleteProperties' => [ 'shape' => 'ImageDeletePropertyList', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'UpdateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'AliasesToAdd' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'AliasesToDelete' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'UpdateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'UpdateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], ], ], 'UpdateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'UpdateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], ], ], 'UpdateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'UpdateModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'CustomerMetadataPropertiesToRemove' => [ 'shape' => 'CustomerMetadataKeyList', ], 'AdditionalInferenceSpecificationsToAdd' => [ 'shape' => 'AdditionalInferenceSpecifications', ], ], ], 'UpdateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'UpdateMonitoringAlertRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'DatapointsToAlert', 'EvaluationPeriod', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], ], ], 'UpdateMonitoringAlertResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], ], ], 'UpdateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], ], ], 'UpdateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'UpdateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DisassociateLifecycleConfig' => [ 'shape' => 'DisassociateNotebookInstanceLifecycleConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DisassociateAcceleratorTypes' => [ 'shape' => 'DisassociateNotebookInstanceAcceleratorTypes', ], 'DisassociateDefaultCodeRepository' => [ 'shape' => 'DisassociateDefaultCodeRepository', ], 'DisassociateAdditionalCodeRepositories' => [ 'shape' => 'DisassociateAdditionalCodeRepositories', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'UpdatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'UpdateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'shape' => 'ServiceCatalogProvisioningUpdateDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'UpdateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], ], ], 'UpdateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], ], ], 'UpdateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'UpdateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfigForUpdate', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfigForUpdate', ], ], ], 'UpdateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'UpdateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'ParametersToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'InputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], ], ], 'UpdateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'UpdateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'UpdateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'UpdateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'UpdateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'UpdateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'UpdateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'UpdateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'UpdateWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Url' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'UserContext' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'String', ], 'UserProfileName' => [ 'shape' => 'String', ], 'DomainId' => [ 'shape' => 'String', ], 'IamIdentity' => [ 'shape' => 'IamIdentity', ], ], ], 'UserProfileArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/.*', ], 'UserProfileDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'UserProfileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProfileDetails', ], ], 'UserProfileName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'UserProfileSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'UserProfileStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'UserSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'SharingSettings' => [ 'shape' => 'SharingSettings', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'TensorBoardAppSettings' => [ 'shape' => 'TensorBoardAppSettings', ], 'RStudioServerProAppSettings' => [ 'shape' => 'RStudioServerProAppSettings', ], 'RSessionAppSettings' => [ 'shape' => 'RSessionAppSettings', ], 'CanvasAppSettings' => [ 'shape' => 'CanvasAppSettings', ], ], ], 'UsersPerStep' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'UtilizationMetric' => [ 'type' => 'float', 'min' => 0.0, ], 'UtilizationPercentagePerCore' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ValidationFraction' => [ 'type' => 'float', 'max' => 1, 'min' => 0, ], 'VariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'VariantProperty' => [ 'type' => 'structure', 'required' => [ 'VariantPropertyType', ], 'members' => [ 'VariantPropertyType' => [ 'shape' => 'VariantPropertyType', ], ], ], 'VariantPropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantProperty', ], 'max' => 3, 'min' => 0, ], 'VariantPropertyType' => [ 'type' => 'string', 'enum' => [ 'DesiredInstanceCount', 'DesiredWeight', 'DataCaptureConfig', ], ], 'VariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'Deleting', 'ActivatingTraffic', 'Baking', ], ], 'VariantStatusMessage' => [ 'type' => 'string', 'max' => 1024, ], 'VariantWeight' => [ 'type' => 'float', 'min' => 0, ], 'VendorGuidance' => [ 'type' => 'string', 'enum' => [ 'NOT_PROVIDED', 'STABLE', 'TO_BE_ARCHIVED', 'ARCHIVED', ], ], 'VersionId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'VersionedArnOrName' => [ 'type' => 'string', 'max' => 176, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AssociationEntityArn', ], 'Type' => [ 'shape' => 'String40', ], 'LineageType' => [ 'shape' => 'LineageType', ], ], ], 'Vertices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Vertex', ], ], 'VolumeSizeInGB' => [ 'type' => 'integer', 'min' => 1, ], 'VpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'Subnets', ], ], ], 'VpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'VpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WaitIntervalInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'WarmPoolResourceStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Terminated', 'Reused', 'InUse', ], ], 'WarmPoolStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'WarmPoolResourceStatus', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'shape' => 'ResourceRetainedBillableTimeInSeconds', ], 'ReusedByJob' => [ 'shape' => 'TrainingJobName', ], ], ], 'Workforce' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', 'WorkforceArn', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'SubDomain' => [ 'shape' => 'String', ], 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfigForResponse', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigResponse', ], 'Status' => [ 'shape' => 'WorkforceStatus', ], 'FailureReason' => [ 'shape' => 'WorkforceFailureReason', ], ], ], 'WorkforceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/.*', ], 'WorkforceFailureReason' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'WorkforceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$', ], 'WorkforceSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^sg-[0-9a-z]*$', ], 'WorkforceSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WorkforceStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Updating', 'Deleting', 'Failed', 'Active', ], ], 'WorkforceSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^subnet-[0-9a-z]*$', ], 'WorkforceSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSubnetId', ], 'max' => 16, 'min' => 1, ], 'WorkforceVpcConfigRequest' => [ 'type' => 'structure', 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], ], ], 'WorkforceVpcConfigResponse' => [ 'type' => 'structure', 'required' => [ 'VpcId', 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], 'VpcEndpointId' => [ 'shape' => 'WorkforceVpcEndpointId', ], ], ], 'WorkforceVpcEndpointId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpce-[0-9a-z]*$', ], 'WorkforceVpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^vpc-[0-9a-z]*$', ], 'Workforces' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workforce', ], ], 'WorkspaceSettings' => [ 'type' => 'structure', 'members' => [ 'S3ArtifactPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'Workteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'WorkteamArn', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'ProductListingIds' => [ 'shape' => 'ProductListings', ], 'Description' => [ 'shape' => 'String200', ], 'SubDomain' => [ 'shape' => 'String', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'WorkteamArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/.*', ], 'WorkteamName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'Workteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workteam', ], ], ],]; diff --git a/src/data/sagemaker/2017-07-24/docs-2.json b/src/data/sagemaker/2017-07-24/docs-2.json index 90ca213706..e56657bf05 100644 --- a/src/data/sagemaker/2017-07-24/docs-2.json +++ b/src/data/sagemaker/2017-07-24/docs-2.json @@ -171,6 +171,7 @@ "GetLineageGroupPolicy": "The resource policy for the lineage group.
", "GetModelPackageGroupPolicy": "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..
", "GetSagemakerServicecatalogPortfolioStatus": "Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
", + "GetScalingConfigurationRecommendation": "Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.
", "GetSearchSuggestions": "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.
Import hub content.
Hub APIs are only callable through SageMaker Studio.
Lists the actions in your account and their properties.
", @@ -2907,6 +2908,12 @@ "CustomerMetadataMap$value": null } }, + "CustomizedMetricSpecification": { + "base": "A customized metric.
", + "refs": { + "MetricSpecification$Customized": "Information about a customized metric.
" + } + }, "DataCaptureConfig": { "base": "Configuration to control how SageMaker captures inference data.
", "refs": { @@ -4355,6 +4362,12 @@ "DomainDetails$Status": "The status.
" } }, + "Double": { + "base": null, + "refs": { + "TargetTrackingScalingPolicyConfiguration$TargetValue": "The recommended target value to specify for the metric when creating a scaling policy.
" + } + }, "DoubleParameterValue": { "base": null, "refs": { @@ -4393,6 +4406,12 @@ "DriftCheckBaselines$ModelQuality": "Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
" } }, + "DynamicScalingConfiguration": { + "base": "An object with the recommended values for you to specify when creating an autoscaling policy.
", + "refs": { + "GetScalingConfigurationRecommendationResponse$DynamicScalingConfiguration": "An object with the recommended values for you to specify when creating an autoscaling policy.
" + } + }, "EMRStepMetadata": { "base": "The configurations and outcomes of an Amazon EMR step execution.
", "refs": { @@ -4717,6 +4736,8 @@ "EndpointInput$EndpointName": "An endpoint in customer's account which has enabled DataCaptureConfig enabled.
The name of the endpoint.
", "EndpointSummary$EndpointName": "The name of the endpoint.
", + "GetScalingConfigurationRecommendationRequest$EndpointName": "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.
The name of an endpoint benchmarked during a previously completed Inference Recommender job.
", "ListDataQualityJobDefinitionsRequest$EndpointName": "A filter that lists the data quality job definitions associated with the specified endpoint.
", "ListModelBiasJobDefinitionsRequest$EndpointName": "Name of the endpoint to monitor for model bias.
", "ListModelExplainabilityJobDefinitionsRequest$EndpointName": "Name of the endpoint to monitor for model explainability.
", @@ -5723,6 +5744,16 @@ "refs": { } }, + "GetScalingConfigurationRecommendationRequest": { + "base": null, + "refs": { + } + }, + "GetScalingConfigurationRecommendationResponse": { + "base": null, + "refs": { + } + }, "GetSearchSuggestionsRequest": { "base": null, "refs": { @@ -6864,6 +6895,10 @@ "DescribeModelCardExportJobResponse$ModelCardVersion": "The version of the model card that the model export job exports.
", "DescribeModelCardRequest$ModelCardVersion": "The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
", "DescribeModelCardResponse$ModelCardVersion": "The version of the model card.
", + "DynamicScalingConfiguration$MinCapacity": "The recommended minimum capacity to specify for your autoscaling policy.
", + "DynamicScalingConfiguration$MaxCapacity": "The recommended maximum capacity to specify for your autoscaling policy.
", + "DynamicScalingConfiguration$ScaleInCooldown": "The recommended scale in cooldown time for your autoscaling policy.
", + "DynamicScalingConfiguration$ScaleOutCooldown": "The recommended scale out cooldown time for your autoscaling policy.
", "EdgeDeploymentPlanSummary$EdgeDeploymentSuccess": "The number of edge devices with the successful deployment.
", "EdgeDeploymentPlanSummary$EdgeDeploymentPending": "The number of edge devices yet to pick up the deployment, or in progress.
", "EdgeDeploymentPlanSummary$EdgeDeploymentFailed": "The number of edge devices that failed the deployment.
", @@ -6882,7 +6917,11 @@ "ModelLatencyThreshold$ValueInMilliseconds": "The model latency percentile value in milliseconds.
", "RecommendationJobStoppingConditions$MaxInvocations": "The maximum number of requests per minute expected for the endpoint.
", "RecommendationMetrics$MaxInvocations": "The expected maximum number of requests per minute for the instance.
", - "RecommendationMetrics$ModelLatency": "The expected model latency at maximum invocation per minute for the instance.
" + "RecommendationMetrics$ModelLatency": "The expected model latency at maximum invocation per minute for the instance.
", + "ScalingPolicyMetric$InvocationsPerInstance": "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. 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.
", + "ScalingPolicyObjective$MinInvocationsPerMinute": "The minimum number of expected requests to your endpoint per minute.
", + "ScalingPolicyObjective$MaxInvocationsPerMinute": "The maximum number of expected requests to your endpoint per minute.
" } }, "IntegerParameterRange": { @@ -8500,6 +8539,12 @@ "MetricDatum$Set": "The dataset split from which the AutoML job produced the metric.
" } }, + "MetricSpecification": { + "base": "An object containing information about a metric.
", + "refs": { + "TargetTrackingScalingPolicyConfiguration$MetricSpecification": "An object containing information about a metric.
" + } + }, "MetricValue": { "base": null, "refs": { @@ -10718,6 +10763,12 @@ "PutModelPackageGroupPolicyInput$ResourcePolicy": "The resource policy for the model group.
" } }, + "PredefinedMetricSpecification": { + "base": "A specification for a predefined metric.
", + "refs": { + "MetricSpecification$Predefined": "Information about a predefined metric.
" + } + }, "PresignedDomainUrl": { "base": null, "refs": { @@ -11504,6 +11555,8 @@ "CreateInferenceRecommendationsJobRequest$JobName": "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.
", "DescribeInferenceRecommendationsJobRequest$JobName": "The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "DescribeInferenceRecommendationsJobResponse$JobName": "The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", + "GetScalingConfigurationRecommendationRequest$InferenceRecommendationsJobName": "The name of a previously completed Inference Recommender job.
", + "GetScalingConfigurationRecommendationResponse$InferenceRecommendationsJobName": "The name of a previously completed Inference Recommender job.
", "InferenceRecommendationsJob$JobName": "The name of the job.
", "InferenceRecommendationsJobStep$JobName": "The name of the Inference Recommender job.
", "ListInferenceRecommendationsJobStepsRequest$JobName": "The name for the Inference Recommender job.
", @@ -12179,6 +12232,31 @@ "DataCaptureConfigSummary$CurrentSamplingPercentage": "The percentage of requests being captured by your Endpoint.
" } }, + "ScalingPolicies": { + "base": null, + "refs": { + "DynamicScalingConfiguration$ScalingPolicies": "An object of the scaling policies for each metric.
" + } + }, + "ScalingPolicy": { + "base": "An object containing a recommended scaling policy.
", + "refs": { + "ScalingPolicies$member": null + } + }, + "ScalingPolicyMetric": { + "base": "The metric for a scaling policy.
", + "refs": { + "GetScalingConfigurationRecommendationResponse$Metric": "An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.
" + } + }, + "ScalingPolicyObjective": { + "base": "An object where you specify the anticipated traffic pattern for an endpoint.
", + "refs": { + "GetScalingConfigurationRecommendationRequest$ScalingPolicyObjective": "An object where you specify the anticipated traffic pattern for an endpoint.
", + "GetScalingConfigurationRecommendationResponse$ScalingPolicyObjective": "An object representing the anticipated traffic pattern for an endpoint that you specified in the request.
" + } + }, "ScheduleConfig": { "base": "Configuration details about the monitoring schedule.
", "refs": { @@ -12735,6 +12813,12 @@ "refs": { } }, + "Statistic": { + "base": null, + "refs": { + "CustomizedMetricSpecification$Statistic": "The statistic of the customized metric.
" + } + }, "StatusDetails": { "base": null, "refs": { @@ -12875,6 +12959,8 @@ "BatchTransformInput$ProbabilityAttribute": "In a classification problem, the attribute that represents the class probability.
", "CreateModelPackageInput$Domain": "The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
", "CreateModelPackageInput$Task": "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.
", + "CustomizedMetricSpecification$MetricName": "The name of the customized metric.
", + "CustomizedMetricSpecification$Namespace": "The namespace of the customized metric.
", "DescribeEdgePackagingJobResponse$EdgePackagingJobStatusMessage": "Returns a message describing the job status and error messages.
", "DescribeEdgePackagingJobResponse$ModelSignature": "The signature document of files in the model artifact.
", "DescribeModelPackageOutput$Domain": "The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
", @@ -12892,6 +12978,8 @@ "EnvironmentParameter$Key": "The environment key suggested by the Amazon SageMaker Inference Recommender.
", "EnvironmentParameter$ValueType": "The value type suggested by the Amazon SageMaker Inference Recommender.
", "EnvironmentParameter$Value": "The value suggested by the Amazon SageMaker Inference Recommender.
", + "GetScalingConfigurationRecommendationRequest$RecommendationId": "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 recommendation ID of a previously completed inference recommendation.
", "IamIdentity$Arn": "The Amazon Resource Name (ARN) of the IAM identity.
", "IamIdentity$PrincipalId": "The ID of the principal that assumes the IAM identity.
", "IamIdentity$SourceIdentity": "The person or application which assumes the IAM identity.
", @@ -12913,6 +13001,7 @@ "ModelPackageContainerDefinition$Framework": "The machine learning framework of the model package container image.
", "ModelPackageContainerDefinition$NearestModelName": "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.
if the overall status is Failed, the reason for the failure.
The metric type. You can only apply SageMaker metric types to SageMaker endpoints.
", "ProcessingInput$InputName": "The name for the processing job input.
", "ProcessingOutput$OutputName": "The name for the processing job output.
", "ProductListings$member": null, @@ -13346,6 +13435,12 @@ "TargetPlatform$Os": "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}
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.
A target tracking scaling policy. Includes support for predefined or customized metrics.
" + } + }, "TaskAvailabilityLifetimeInSeconds": { "base": null, "refs": { @@ -14996,6 +15091,13 @@ "RecommendationMetrics$MemoryUtilization": "The expected memory utilization at maximum invocations per minute for the instance.
NaN indicates that the value is not available.
The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.
", + "GetScalingConfigurationRecommendationResponse$TargetCpuUtilizationPerCore": "The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.
" + } + }, "ValidationFraction": { "base": null, "refs": { diff --git a/src/data/sagemaker/2017-07-24/docs-2.json.php b/src/data/sagemaker/2017-07-24/docs-2.json.php index e6a4e874bf..bb5e634a89 100644 --- a/src/data/sagemaker/2017-07-24/docs-2.json.php +++ b/src/data/sagemaker/2017-07-24/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Provides APIs for creating and managing SageMaker resources.
Other Resources:
', 'operations' => [ 'AddAssociation' => '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.
', 'AddTags' => '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 Studio 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.
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.
', 'BatchDescribeModelPackage' => 'This action batch describes a list of versioned model packages
', 'CreateAction' => '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.
', 'CreateAlgorithm' => 'Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
', 'CreateApp' => 'Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
', 'CreateAppImageConfig' => 'Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.
', 'CreateArtifact' => '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.
', 'CreateAutoMLJob' => 'Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
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 non-tabular problem types such as image or text classification.
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.
', 'CreateAutoMLJobV2' => 'Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
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 non-tabular problem types such as image or text classification.
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.
', 'CreateCodeRepository' => 'Creates a Git repository as a resource in your SageMaker 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 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.
', 'CreateCompilationJob' => 'Starts a model compilation job. After the model has been compiled, Amazon SageMaker 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 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 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.
', 'CreateContext' => '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.
', 'CreateDataQualityJobDefinition' => 'Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
', 'CreateDeviceFleet' => 'Creates a device fleet.
', 'CreateDomain' => 'Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) 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 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 SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly - All Studio 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 Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker 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 SageMaker Studio app successfully.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
', 'CreateEdgeDeploymentPlan' => 'Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
', 'CreateEdgeDeploymentStage' => 'Creates a new stage in an existing edge deployment plan.
', 'CreateEdgePackagingJob' => 'Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
', 'CreateEndpoint' => 'Creates 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.
For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook.
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 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.
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.
', 'CreateFeatureGroup' => '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.
You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.
Creates a flow definition.
', 'CreateHub' => 'Create a hub.
Hub APIs are only callable through SageMaker Studio.
Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
', 'CreateHyperParameterTuningJob' => 'Starts 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 field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image.
', 'CreateImageVersion' => 'Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.
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.
', 'CreateInferenceRecommendationsJob' => 'Starts a recommendation job. You can create either an instance recommendation or load test job.
', 'CreateLabelingJob' => '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.
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.
For an example that calls this method when deploying a model to SageMaker hosting services, see Create a Model (Amazon Web Services SDK for Python (Boto 3)).
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.
', 'CreateModelBiasJobDefinition' => 'Creates the definition for a model bias job.
', 'CreateModelCard' => 'Creates an Amazon SageMaker Model Card.
For information about how to use model cards, see Amazon SageMaker Model Card.
', 'CreateModelCardExportJob' => 'Creates an Amazon SageMaker Model Card export job.
', 'CreateModelExplainabilityJobDefinition' => 'Creates the definition for a model explainability job.
', 'CreateModelPackage' => '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 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.
Creates a model group. A model group contains a group of model versions.
', 'CreateModelQualityJobDefinition' => 'Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
', 'CreateMonitoringSchedule' => 'Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.
', 'CreateNotebookInstance' => 'Creates an SageMaker 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 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 also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.
After receiving the request, SageMaker does the following:
Creates a network interface in the SageMaker VPC.
(Option) If you specified SubnetId, SageMaker 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 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 VPC. If you specified SubnetId of your VPC, SageMaker 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 returns its Amazon Resource Name (ARN). You can\'t change the name of a notebook instance after you create it.
After SageMaker 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 endpoints, and validate hosted models.
For more information, see How It Works.
', 'CreateNotebookInstanceLifecycleConfig' => '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 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.
', 'CreatePipeline' => 'Creates a pipeline using a JSON pipeline definition.
', 'CreatePresignedDomainUrl' => 'Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of the Apps and files associated with the Domain\'s Amazon Elastic File System (EFS) 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 SageMaker 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.
Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker 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.
Creates a processing job.
', 'CreateProject' => '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.
', 'CreateSpace' => 'Creates a space used for real time collaboration in a Domain.
', 'CreateStudioLifecycleConfig' => 'Creates a new Studio Lifecycle Configuration.
', 'CreateTrainingJob' => '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 field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
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.
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.
', 'CreateTransformJob' => '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 for the transform job.
For more information about how batch transformation works, see Batch Transform.
', 'CreateTrial' => '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.
', 'CreateTrialComponent' => '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.
', 'CreateUserProfile' => '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 Amazon SageMaker Studio. 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 (EFS) home directory.
', 'CreateWorkforce' => '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).
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.
', 'DeleteAction' => 'Deletes an action.
', 'DeleteAlgorithm' => 'Removes the specified algorithm from your account.
', 'DeleteApp' => 'Used to stop and delete an app.
', 'DeleteAppImageConfig' => 'Deletes an AppImageConfig.
', 'DeleteArtifact' => 'Deletes an artifact. Either ArtifactArn or Source must be specified.
Deletes an association.
', 'DeleteCodeRepository' => 'Deletes the specified Git repository from your account.
', 'DeleteContext' => 'Deletes an context.
', 'DeleteDataQualityJobDefinition' => 'Deletes a data quality monitoring job definition.
', 'DeleteDeviceFleet' => 'Deletes a fleet.
', 'DeleteDomain' => '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.
', 'DeleteEdgeDeploymentPlan' => '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.
', 'DeleteEdgeDeploymentStage' => 'Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
', 'DeleteEndpoint' => '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 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 first. Use the ListTrials API to get a list of the trials associated with the experiment.
', 'DeleteFeatureGroup' => '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.
Deletes the specified flow definition.
', 'DeleteHub' => 'Delete a hub.
Hub APIs are only callable through SageMaker Studio.
Delete the contents of a hub.
Hub APIs are only callable through SageMaker Studio.
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 SageMaker image and all versions of the image. The container images aren\'t deleted.
', 'DeleteImageVersion' => 'Deletes a version of a SageMaker image. The container image the version represents isn\'t deleted.
', 'DeleteInferenceExperiment' => 'Deletes an inference experiment.
This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.
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 an Amazon SageMaker model bias job definition.
', 'DeleteModelCard' => 'Deletes an Amazon SageMaker Model Card.
', 'DeleteModelExplainabilityJobDefinition' => 'Deletes an Amazon SageMaker model explainability job definition.
', 'DeleteModelPackage' => '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.
', 'DeleteModelPackageGroup' => 'Deletes the specified model group.
', 'DeleteModelPackageGroupPolicy' => 'Deletes a model group resource policy.
', 'DeleteModelQualityJobDefinition' => 'Deletes the secified model quality monitoring job definition.
', 'DeleteMonitoringSchedule' => '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.
', 'DeleteNotebookInstance' => ' Deletes an SageMaker 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 removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
Deletes a notebook instance lifecycle configuration.
', 'DeletePipeline' => '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.
Delete the specified project.
', 'DeleteSpace' => 'Used to delete a space.
', 'DeleteStudioLifecycleConfig' => 'Deletes the 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.
', 'DeleteTags' => 'Deletes 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 Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API.
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.
', 'DeleteTrialComponent' => '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.
', 'DeleteUserProfile' => 'Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.
', 'DeleteWorkforce' => '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 recieve a ResourceInUse error.
Deletes an existing work team. This operation can\'t be undone.
', 'DeregisterDevices' => 'Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
', 'DescribeAction' => 'Describes an action.
', 'DescribeAlgorithm' => 'Returns a description of the specified algorithm that is in your account.
', 'DescribeApp' => 'Describes the app.
', 'DescribeAppImageConfig' => 'Describes an AppImageConfig.
', 'DescribeArtifact' => 'Describes an artifact.
', 'DescribeAutoMLJob' => 'Returns information about an AutoML job created by calling CreateAutoMLJob.
AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.
Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.
', 'DescribeCodeRepository' => 'Gets details about the specified Git repository.
', 'DescribeCompilationJob' => '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.
', 'DescribeContext' => 'Describes a context.
', 'DescribeDataQualityJobDefinition' => 'Gets the details of a data quality monitoring job definition.
', 'DescribeDevice' => 'Describes the device.
', 'DescribeDeviceFleet' => 'A description of the fleet the device belongs to.
', 'DescribeDomain' => 'The description of the domain.
', 'DescribeEdgeDeploymentPlan' => 'Describes an edge deployment plan with deployment status per stage.
', 'DescribeEdgePackagingJob' => 'A description of edge packaging jobs.
', 'DescribeEndpoint' => 'Returns the description of an endpoint.
', 'DescribeEndpointConfig' => 'Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Provides a list of an experiment\'s properties.
', 'DescribeFeatureGroup' => '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.
Shows the metadata for a feature within a feature group.
', 'DescribeFlowDefinition' => 'Returns information about the specified flow definition.
', 'DescribeHub' => 'Describe a hub.
Hub APIs are only callable through SageMaker Studio.
Describe the content of a hub.
Hub APIs are only callable through SageMaker Studio.
Returns information about the requested human task user interface (worker task template).
', 'DescribeHyperParameterTuningJob' => '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.
', 'DescribeImage' => 'Describes a SageMaker image.
', 'DescribeImageVersion' => 'Describes a version of a SageMaker image.
', 'DescribeInferenceExperiment' => 'Returns details about an inference experiment.
', 'DescribeInferenceRecommendationsJob' => 'Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.
', 'DescribeLabelingJob' => 'Gets information about a labeling job.
', 'DescribeLineageGroup' => 'Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
', 'DescribeModel' => 'Describes a model that you created using the CreateModel API.
Returns a description of a model bias job definition.
', 'DescribeModelCard' => 'Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
', 'DescribeModelCardExportJob' => 'Describes an Amazon SageMaker Model Card export job.
', 'DescribeModelExplainabilityJobDefinition' => 'Returns a description of a model explainability job definition.
', 'DescribeModelPackage' => 'Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
', 'DescribeModelPackageGroup' => 'Gets a description for the specified model group.
', 'DescribeModelQualityJobDefinition' => 'Returns a description of a model quality job definition.
', 'DescribeMonitoringSchedule' => 'Describes the schedule for a monitoring job.
', 'DescribeNotebookInstance' => 'Returns information about a notebook instance.
', 'DescribeNotebookInstanceLifecycleConfig' => '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.
', 'DescribePipeline' => 'Describes the details of a pipeline.
', 'DescribePipelineDefinitionForExecution' => 'Describes the details of an execution\'s pipeline definition.
', 'DescribePipelineExecution' => 'Describes the details of a pipeline execution.
', 'DescribeProcessingJob' => 'Returns a description of a processing job.
', 'DescribeProject' => 'Describes the details of a project.
', 'DescribeSpace' => 'Describes the space.
', 'DescribeStudioLifecycleConfig' => 'Describes the Studio Lifecycle Configuration.
', 'DescribeSubscribedWorkteam' => '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.
', 'DescribeTrainingJob' => '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.
Returns information about a transform job.
', 'DescribeTrial' => 'Provides a list of a trial\'s properties.
', 'DescribeTrialComponent' => 'Provides a list of a trials component\'s properties.
', 'DescribeUserProfile' => 'Describes a user profile. For more information, see CreateUserProfile.
Lists 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.
Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team\'s Amazon Resource Name (ARN).
', 'DisableSagemakerServicecatalogPortfolio' => 'Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
', 'DisassociateTrialComponent' => '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.
Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
', 'GetDeviceFleetReport' => 'Describes a fleet.
', 'GetLineageGroupPolicy' => 'The resource policy for the lineage group.
', 'GetModelPackageGroupPolicy' => '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..
', 'GetSagemakerServicecatalogPortfolioStatus' => 'Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
', 'GetSearchSuggestions' => '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.
Import hub content.
Hub APIs are only callable through SageMaker Studio.
Lists the actions in your account and their properties.
', 'ListAlgorithms' => 'Lists the machine learning algorithms that have been created.
', 'ListAliases' => 'Lists the aliases of a specified image or image version.
', 'ListAppImageConfigs' => '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.
', 'ListApps' => 'Lists apps.
', 'ListArtifacts' => 'Lists the artifacts in your account and their properties.
', 'ListAssociations' => 'Lists the associations in your account and their properties.
', 'ListAutoMLJobs' => 'Request a list of jobs.
', 'ListCandidatesForAutoMLJob' => 'List the candidates created for the job.
', 'ListCodeRepositories' => 'Gets a list of the Git repositories in your account.
', 'ListCompilationJobs' => '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.
', 'ListContexts' => 'Lists the contexts in your account and their properties.
', 'ListDataQualityJobDefinitions' => 'Lists the data quality job definitions in your account.
', 'ListDeviceFleets' => 'Returns a list of devices in the fleet.
', 'ListDevices' => 'A list of devices.
', 'ListDomains' => 'Lists the domains.
', 'ListEdgeDeploymentPlans' => 'Lists all edge deployment plans.
', 'ListEdgePackagingJobs' => 'Returns a list of edge packaging jobs.
', 'ListEndpointConfigs' => 'Lists endpoint configurations.
', 'ListEndpoints' => 'Lists endpoints.
', 'ListExperiments' => '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.
', 'ListFeatureGroups' => 'List FeatureGroups based on given filter and order.
Returns information about the flow definitions in your account.
', 'ListHubContentVersions' => 'List hub content versions.
Hub APIs are only callable through SageMaker Studio.
List the contents of a hub.
Hub APIs are only callable through SageMaker Studio.
List all existing hubs.
Hub APIs are only callable through SageMaker Studio.
Returns information about the human task user interfaces in your account.
', 'ListHyperParameterTuningJobs' => 'Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
', 'ListImageVersions' => 'Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
', 'ListImages' => '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.
', 'ListInferenceExperiments' => 'Returns the list of all inference experiments.
', 'ListInferenceRecommendationsJobSteps' => '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.
', 'ListInferenceRecommendationsJobs' => 'Lists recommendation jobs that satisfy various filters.
', 'ListLabelingJobs' => 'Gets a list of labeling jobs.
', 'ListLabelingJobsForWorkteam' => 'Gets a list of labeling jobs assigned to a specified work team.
', 'ListLineageGroups' => '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.
', 'ListModelBiasJobDefinitions' => 'Lists model bias jobs definitions that satisfy various filters.
', 'ListModelCardExportJobs' => 'List the export jobs for the Amazon SageMaker Model Card.
', 'ListModelCardVersions' => 'List existing versions of an Amazon SageMaker Model Card.
', 'ListModelCards' => 'List existing model cards.
', 'ListModelExplainabilityJobDefinitions' => 'Lists model explainability job definitions that satisfy various filters.
', 'ListModelMetadata' => 'Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.
', 'ListModelPackageGroups' => 'Gets a list of the model groups in your Amazon Web Services account.
', 'ListModelPackages' => 'Lists the model packages that have been created.
', 'ListModelQualityJobDefinitions' => 'Gets a list of model quality monitoring job definitions in your account.
', 'ListModels' => 'Lists models created with the CreateModel API.
Gets a list of past alerts in a model monitoring schedule.
', 'ListMonitoringAlerts' => 'Gets the alerts for a single monitoring schedule.
', 'ListMonitoringExecutions' => 'Returns list of all monitoring job executions.
', 'ListMonitoringSchedules' => 'Returns list of all monitoring schedules.
', 'ListNotebookInstanceLifecycleConfigs' => 'Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
', 'ListNotebookInstances' => 'Returns a list of the SageMaker notebook instances in the requester\'s account in an Amazon Web Services Region.
', 'ListPipelineExecutionSteps' => 'Gets a list of PipeLineExecutionStep objects.
Gets a list of the pipeline executions.
', 'ListPipelineParametersForExecution' => 'Gets a list of parameters for a pipeline execution.
', 'ListPipelines' => 'Gets a list of pipelines.
', 'ListProcessingJobs' => 'Lists processing jobs that satisfy various filters.
', 'ListProjects' => 'Gets a list of the projects in an Amazon Web Services account.
', 'ListResourceCatalogs' => ' Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.
Lists spaces.
', 'ListStageDevices' => 'Lists devices allocated to the stage, containing detailed device information and deployment status.
', 'ListStudioLifecycleConfigs' => 'Lists the Studio Lifecycle Configurations in your Amazon Web Services Account.
', 'ListSubscribedWorkteams' => '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.
Returns the tags for the specified SageMaker resource.
', 'ListTrainingJobs' => '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 hyperparameter tuning job launched.
', 'ListTransformJobs' => 'Lists transform jobs.
', 'ListTrialComponents' => '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
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.
', 'ListUserProfiles' => 'Lists user profiles.
', 'ListWorkforces' => '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.
', 'ListWorkteams' => '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.
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..
', 'QueryLineage' => '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.
', 'RegisterDevices' => 'Register devices.
', 'RenderUiTemplate' => 'Renders the UI template so that you can preview the worker\'s experience.
', 'RetryPipelineExecution' => 'Retry the execution of the pipeline.
', 'Search' => 'Finds 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.
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).
', 'SendPipelineExecutionStepSuccess' => '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).
', 'StartEdgeDeploymentStage' => 'Starts a stage in an edge deployment plan.
', 'StartInferenceExperiment' => 'Starts an inference experiment.
', 'StartMonitoringSchedule' => '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 attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance\'s status must be InService before you can connect to your Jupyter notebook.
Starts a pipeline execution.
', 'StopAutoMLJob' => 'A method for forcing a running job to shut down.
', 'StopCompilationJob' => 'Stops a model compilation job.
To stop a job, Amazon SageMaker 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 changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.
Stops a stage in an edge deployment plan.
', 'StopEdgePackagingJob' => 'Request to stop an edge packaging job.
', 'StopHyperParameterTuningJob' => '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.
Stops an inference experiment.
', 'StopInferenceRecommendationsJob' => 'Stops an Inference Recommender job.
', 'StopLabelingJob' => '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.
', 'StopMonitoringSchedule' => 'Stops a previously started monitoring schedule.
', 'StopNotebookInstance' => 'Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker 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.
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.
Stops a processing job.
', 'StopTrainingJob' => '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.
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.
Updates an action.
', 'UpdateAppImageConfig' => 'Updates the properties of an AppImageConfig.
', 'UpdateArtifact' => 'Updates an artifact.
', 'UpdateCodeRepository' => 'Updates the specified Git repository with the specified values.
', 'UpdateContext' => 'Updates a context.
', 'UpdateDeviceFleet' => 'Updates a fleet of devices.
', 'UpdateDevices' => 'Updates one or more devices in a fleet.
', 'UpdateDomain' => 'Updates the default settings for new user profiles in the domain.
', 'UpdateEndpoint' => 'Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).
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.
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 experiment.
', 'UpdateFeatureGroup' => '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.
Updates the description and parameters of the feature group.
', 'UpdateHub' => 'Update a hub.
Hub APIs are only callable through SageMaker Studio.
Updates the properties of a SageMaker image. To change the image\'s tags, use the AddTags and DeleteTags APIs.
', 'UpdateImageVersion' => 'Updates the properties of a SageMaker image version.
', 'UpdateInferenceExperiment' => ' 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.
Update an Amazon SageMaker Model Card.
You cannot update both model card content and model card status in a single call.
Updates a versioned model.
', 'UpdateMonitoringAlert' => 'Update the parameters of a model monitor alert.
', 'UpdateMonitoringSchedule' => 'Updates a previously created schedule.
', 'UpdateNotebookInstance' => '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.
', 'UpdateNotebookInstanceLifecycleConfig' => 'Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
', 'UpdatePipeline' => 'Updates a pipeline.
', 'UpdatePipelineExecution' => 'Updates a pipeline execution.
', 'UpdateProject' => '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.
Updates the settings of a space.
', 'UpdateTrainingJob' => 'Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.
', 'UpdateTrial' => 'Updates the display name of a trial.
', 'UpdateTrialComponent' => 'Updates one or more properties of a trial component.
', 'UpdateUserProfile' => 'Updates a user profile.
', 'UpdateWorkforce' => 'Use 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.
Updates an existing work team with new member definitions or description.
', ], 'shapes' => [ 'Accept' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$Accept' => '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.
', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'LabelingJobForWorkteamSummary$WorkRequesterAccountId' => 'The Amazon Web Services account ID of the account used to start the labeling job.
', ], ], 'ActionArn' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', 'CreateActionResponse$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', 'DeleteActionResponse$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', 'DescribeActionResponse$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', 'UpdateActionResponse$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', ], ], 'ActionSource' => [ 'base' => 'A structure describing the source of an action.
', 'refs' => [ 'ActionSummary$Source' => 'The source of the action.
', 'CreateActionRequest$Source' => 'The source type, ID, and URI.
', 'DescribeActionResponse$Source' => 'The source of the action.
', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$Status' => 'The status of the action.
', 'CreateActionRequest$Status' => 'The status of the action.
', 'DescribeActionResponse$Status' => 'The status of the action.
', 'UpdateActionRequest$Status' => 'The new status for the action.
', ], ], 'ActionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListActionsResponse$ActionSummaries' => 'A list of actions and their properties.
', ], ], 'ActionSummary' => [ 'base' => '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.
', 'refs' => [ 'ActionSummaries$member' => NULL, ], ], 'AddAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AdditionalCodeRepositories' => '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 Notebook Instances.
', 'DescribeNotebookInstanceOutput$AdditionalCodeRepositories' => '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 Notebook Instances.
', 'NotebookInstanceSummary$AdditionalCodeRepositories' => '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 Notebook Instances.
', 'UpdateNotebookInstanceInput$AdditionalCodeRepositories' => '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 Notebook Instances.
', ], ], 'AdditionalInferenceSpecificationDefinition' => [ 'base' => '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
', 'refs' => [ 'AdditionalInferenceSpecifications$member' => NULL, ], ], 'AdditionalInferenceSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$AdditionalInferenceSpecifications' => '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.
', 'DescribeModelPackageOutput$AdditionalInferenceSpecifications' => '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.
', 'ModelPackage$AdditionalInferenceSpecifications' => 'An array of additional Inference Specification objects.
', 'UpdateModelPackageInput$AdditionalInferenceSpecificationsToAdd' => '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.
', ], ], 'AgentVersion' => [ 'base' => 'Edge Manager agent version.
', 'refs' => [ 'AgentVersions$member' => NULL, ], ], 'AgentVersions' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$AgentVersions' => 'The versions of Edge Manager agent deployed on the fleet.
', ], ], 'AggregationTransformationValue' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$value' => NULL, ], ], 'AggregationTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Aggregation' => 'A 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.
An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
', 'refs' => [ 'AlarmList$member' => NULL, ], ], 'AlarmList' => [ 'base' => NULL, 'refs' => [ 'AutoRollbackConfig$Alarms' => '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.
', ], ], 'AlarmName' => [ 'base' => NULL, 'refs' => [ 'Alarm$AlarmName' => 'The name of a CloudWatch alarm in your account.
', ], ], 'AlgorithmArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmArn' => 'The Amazon Resource Name (ARN) of the algorithm.
', 'CreateAlgorithmOutput$AlgorithmArn' => 'The Amazon Resource Name (ARN) of the new algorithm.
', 'DescribeAlgorithmOutput$AlgorithmArn' => 'The Amazon Resource Name (ARN) of the algorithm.
', ], ], 'AlgorithmImage' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$TrainingImage' => '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 Amazon Elastic Container (ECR) Image for the managed rule evaluation.
', 'HyperParameterAlgorithmSpecification$TrainingImage' => ' 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 Amazon Elastic Container Registry Image for the managed rule evaluation.
', ], ], 'AlgorithmSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
Specifies the training algorithm to use in a CreateTrainingJob request.
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.
', 'refs' => [ 'CreateTrainingJobRequest$AlgorithmSpecification' => '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.
', 'DescribeTrainingJobResponse$AlgorithmSpecification' => 'Information about the algorithm used for training, and algorithm metadata.
', 'TrainingJob$AlgorithmSpecification' => 'Information about the algorithm used for training, and algorithm metadata.
', ], ], 'AlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmStatus' => 'The overall status of the algorithm.
', 'DescribeAlgorithmOutput$AlgorithmStatus' => 'The current status of the algorithm.
', ], ], 'AlgorithmStatusDetails' => [ 'base' => 'Specifies the validation and image scan statuses of the algorithm.
', 'refs' => [ 'DescribeAlgorithmOutput$AlgorithmStatusDetails' => 'Details about the current status of the algorithm.
', ], ], 'AlgorithmStatusItem' => [ 'base' => 'Represents the overall status of an algorithm.
', 'refs' => [ 'AlgorithmStatusItemList$member' => NULL, ], ], 'AlgorithmStatusItemList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusDetails$ValidationStatuses' => 'The status of algorithm validation.
', 'AlgorithmStatusDetails$ImageScanStatuses' => 'The status of the scan of the algorithm\'s Docker image container.
', ], ], 'AlgorithmSummary' => [ 'base' => 'Provides summary information about an algorithm.
', 'refs' => [ 'AlgorithmSummaryList$member' => NULL, ], ], 'AlgorithmSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsOutput$AlgorithmSummaryList' => '>An array of AlgorithmSummary objects, each of which lists an algorithm.
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.
', 'refs' => [ 'AlgorithmValidationProfiles$member' => NULL, ], ], 'AlgorithmValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationProfiles' => '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 algorithm.
', 'refs' => [ 'CreateAlgorithmInput$ValidationSpecification' => '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.
', 'DescribeAlgorithmOutput$ValidationSpecification' => 'Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.
', ], ], 'AnnotationConsolidationConfig' => [ 'base' => 'Configures how labels are consolidated across human workers and processes output data.
', 'refs' => [ 'HumanTaskConfig$AnnotationConsolidationConfig' => 'Configures how labels are consolidated across human workers.
', ], ], 'AppArn' => [ 'base' => NULL, 'refs' => [ 'CreateAppResponse$AppArn' => 'The Amazon Resource Name (ARN) of the app.
', 'DescribeAppResponse$AppArn' => 'The Amazon Resource Name (ARN) of the app.
', ], ], 'AppDetails' => [ 'base' => 'Details about an Amazon SageMaker app.
', 'refs' => [ 'AppList$member' => NULL, ], ], 'AppImageConfigArn' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigArn' => 'The Amazon Resource Name (ARN) of the AppImageConfig.
', 'CreateAppImageConfigResponse$AppImageConfigArn' => 'The Amazon Resource Name (ARN) of the AppImageConfig.
', 'DescribeAppImageConfigResponse$AppImageConfigArn' => 'The Amazon Resource Name (ARN) of the AppImageConfig.
', 'UpdateAppImageConfigResponse$AppImageConfigArn' => 'The Amazon Resource Name (ARN) for the AppImageConfig.
', ], ], 'AppImageConfigDetails' => [ 'base' => 'The configuration for running a SageMaker image as a KernelGateway app.
', 'refs' => [ 'AppImageConfigList$member' => NULL, ], ], 'AppImageConfigList' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsResponse$AppImageConfigs' => 'A list of AppImageConfigs and their properties.
', ], ], 'AppImageConfigName' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigName' => 'The name of the AppImageConfig. Must be unique to your account.
', 'CreateAppImageConfigRequest$AppImageConfigName' => 'The name of the AppImageConfig. Must be unique to your account.
', 'CustomImage$AppImageConfigName' => 'The name of the AppImageConfig.
', 'DeleteAppImageConfigRequest$AppImageConfigName' => 'The name of the AppImageConfig to delete.
', 'DescribeAppImageConfigRequest$AppImageConfigName' => 'The name of the AppImageConfig to describe.
', 'DescribeAppImageConfigResponse$AppImageConfigName' => 'The name of the AppImageConfig.
', 'ListAppImageConfigsRequest$NameContains' => 'A filter that returns only AppImageConfigs whose name contains the specified string.
', 'UpdateAppImageConfigRequest$AppImageConfigName' => 'The name of the AppImageConfig to update.
', ], ], 'AppImageConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsRequest$SortBy' => 'The property used to sort results. The default value is CreationTime.
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 list of apps.
', ], ], 'AppManaged' => [ 'base' => NULL, 'refs' => [ 'ProcessingInput$AppManaged' => '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.
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.
The name of the app.
', 'CreateAppRequest$AppName' => 'The name of the app.
', 'DeleteAppRequest$AppName' => 'The name of the app.
', 'DescribeAppRequest$AppName' => 'The name of the app.
', 'DescribeAppResponse$AppName' => 'The name of the app.
', ], ], 'AppNetworkAccessType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppNetworkAccessType' => '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, which allows direct internet access
VpcOnly - All Studio 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, which allows direct internet access
VpcOnly - All Studio traffic is through the specified VPC and subnets
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 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.
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 parameter by which to sort the results. The default is CreationTime.
', ], ], 'AppSpecification' => [ 'base' => 'Configuration to run a processing job in a specified container image.
', 'refs' => [ 'CreateProcessingJobRequest$AppSpecification' => 'Configures the processing job to run a specified Docker container image.
', 'DescribeProcessingJobResponse$AppSpecification' => 'Configures the processing job to run a specified container image.
', 'ProcessingJob$AppSpecification' => NULL, ], ], 'AppStatus' => [ 'base' => NULL, 'refs' => [ 'AppDetails$Status' => 'The status.
', 'DescribeAppResponse$Status' => 'The status.
', ], ], 'AppType' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppType' => 'The type of app.
', 'CreateAppRequest$AppType' => 'The type of app.
', 'DeleteAppRequest$AppType' => 'The type of app.
', 'DescribeAppRequest$AppType' => 'The type of app.
', 'DescribeAppResponse$AppType' => 'The type of app.
', ], ], 'ApprovalDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageOutput$ApprovalDescription' => 'A description provided for the model approval.
', 'ModelPackage$ApprovalDescription' => 'A description provided when the model approval is set.
', 'UpdateModelPackageInput$ApprovalDescription' => 'A description for the approval status of the model.
', ], ], 'ArnOrName' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$AlgorithmName' => '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.
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.
', 'DeleteModelPackageGroupInput$ModelPackageGroupName' => 'The name of the model group to delete.
', 'DescribeAlgorithmInput$AlgorithmName' => 'The name of the algorithm to describe.
', 'DescribeModelPackageGroupInput$ModelPackageGroupName' => 'The name of gthe model group to describe.
', 'HyperParameterAlgorithmSpecification$AlgorithmName' => '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.
A filter that returns only model versions that belong to the specified model group.
', 'SourceAlgorithm$AlgorithmName' => '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.
', ], ], 'ArtifactArn' => [ 'base' => NULL, 'refs' => [ 'ArtifactSummary$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', 'CreateArtifactResponse$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', 'DeleteArtifactRequest$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact to delete.
', 'DeleteArtifactResponse$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', 'DescribeArtifactRequest$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact to describe.
', 'DescribeArtifactResponse$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', 'UpdateArtifactRequest$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact to update.
', 'UpdateArtifactResponse$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', ], ], 'ArtifactDigest' => [ 'base' => NULL, 'refs' => [ 'ModelDigests$ArtifactDigest' => 'Provides a hash value that uniquely identifies the stored model artifacts.
', ], ], 'ArtifactSource' => [ 'base' => 'A structure describing the source of an artifact.
', 'refs' => [ 'ArtifactSummary$Source' => 'The source of the artifact.
', 'CreateArtifactRequest$Source' => 'The ID, ID type, and URI of the source.
', 'DeleteArtifactRequest$Source' => 'The URI of the source.
', 'DescribeArtifactResponse$Source' => 'The source of the artifact.
', ], ], 'ArtifactSourceIdType' => [ 'base' => NULL, 'refs' => [ 'ArtifactSourceType$SourceIdType' => 'The type of ID.
', ], ], 'ArtifactSourceType' => [ 'base' => 'The ID and ID type of an artifact source.
', 'refs' => [ 'ArtifactSourceTypes$member' => NULL, ], ], 'ArtifactSourceTypes' => [ 'base' => NULL, 'refs' => [ 'ArtifactSource$SourceTypes' => 'A list of source types.
', ], ], 'ArtifactSummaries' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsResponse$ArtifactSummaries' => 'A list of artifacts and their properties.
', ], ], 'ArtifactSummary' => [ 'base' => '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.
', 'refs' => [ 'ArtifactSummaries$member' => NULL, ], ], 'AssemblyType' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$AssembleWith' => '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 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.
The type of the association.
', 'Edge$AssociationType' => 'The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.
A filter that returns only associations of the specified type.
', ], ], 'AssociationEntityArn' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$SourceArn' => 'The ARN of the source.
', 'AddAssociationRequest$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'AddAssociationResponse$SourceArn' => 'The ARN of the source.
', 'AddAssociationResponse$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'AssociationSummary$SourceArn' => 'The ARN of the source.
', 'AssociationSummary$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'DeleteAssociationRequest$SourceArn' => 'The ARN of the source.
', 'DeleteAssociationRequest$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'DeleteAssociationResponse$SourceArn' => 'The ARN of the source.
', 'DeleteAssociationResponse$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'Edge$SourceArn' => 'The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.
', 'Edge$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.
', 'ListAssociationsRequest$SourceArn' => 'A filter that returns only associations with the specified source ARN.
', 'ListAssociationsRequest$DestinationArn' => 'A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
', 'QueryLineageStartArns$member' => NULL, 'Vertex$Arn' => 'The Amazon Resource Name (ARN) of the lineage entity resource.
', ], ], 'AssociationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsResponse$AssociationSummaries' => 'A list of associations and their properties.
', ], ], 'AssociationSummary' => [ 'base' => '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.
', 'refs' => [ 'AssociationSummaries$member' => NULL, ], ], 'AsyncInferenceClientConfig' => [ 'base' => 'Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
', 'refs' => [ 'AsyncInferenceConfig$ClientConfig' => 'Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
', ], ], 'AsyncInferenceConfig' => [ 'base' => 'Specifies configuration for how an endpoint performs asynchronous inference.
', 'refs' => [ 'CreateEndpointConfigInput$AsyncInferenceConfig' => 'Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
', 'DescribeEndpointConfigOutput$AsyncInferenceConfig' => 'Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Specifies the configuration for notifications of inference results for asynchronous inference.
', 'refs' => [ 'AsyncInferenceOutputConfig$NotificationConfig' => 'Specifies the configuration for notifications of inference results for asynchronous inference.
', ], ], 'AsyncInferenceOutputConfig' => [ 'base' => 'Specifies the configuration for asynchronous inference invocation outputs.
', 'refs' => [ 'AsyncInferenceConfig$OutputConfig' => 'Specifies the configuration for asynchronous inference invocation outputs.
', ], ], 'AsyncNotificationTopicTypeList' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$IncludeInferenceResponseIn' => 'The 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.
The name of the data catalog used in Athena query execution.
', 'refs' => [ 'AthenaDatasetDefinition$Catalog' => NULL, ], ], 'AthenaDatabase' => [ 'base' => 'The name of the database used in the Athena query execution.
', 'refs' => [ 'AthenaDatasetDefinition$Database' => NULL, ], ], 'AthenaDatasetDefinition' => [ 'base' => 'Configuration for Athena Dataset Definition input.
', 'refs' => [ 'DatasetDefinition$AthenaDatasetDefinition' => NULL, ], ], 'AthenaQueryString' => [ 'base' => 'The SQL query statements, to be executed.
', 'refs' => [ 'AthenaDatasetDefinition$QueryString' => NULL, ], ], 'AthenaResultCompressionType' => [ 'base' => 'The compression used for Athena query results.
', 'refs' => [ 'AthenaDatasetDefinition$OutputCompression' => NULL, ], ], 'AthenaResultFormat' => [ 'base' => 'The data storage format for Athena query results.
', 'refs' => [ 'AthenaDatasetDefinition$OutputFormat' => NULL, ], ], 'AthenaWorkGroup' => [ 'base' => 'The name of the workgroup in which the Athena query is being started.
', 'refs' => [ 'AthenaDatasetDefinition$WorkGroup' => NULL, ], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'AttributeNames$member' => NULL, ], ], 'AttributeNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$AttributeNames' => 'A list of one or more attribute names to use that are found in a specified augmented manifest file.
', ], ], 'AuthMode' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AuthMode' => 'The mode of authentication that members use to access the domain.
', 'DescribeDomainResponse$AuthMode' => 'The domain\'s authentication mode.
', ], ], 'AutoGenerateEndpointName' => [ 'base' => NULL, 'refs' => [ 'ModelDeployConfig$AutoGenerateEndpointName' => '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.
The collection of algorithms run on a dataset for training the model candidates of an Autopilot job.
', 'refs' => [ 'AutoMLAlgorithmsConfig$member' => NULL, ], ], 'AutoMLAlgorithms' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithmConfig$AutoMLAlgorithms' => 'The selection of algorithms run on a dataset to train the model candidates of an Autopilot job.
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"
Stores the configuration information for the selection of algorithms used to train the model candidates.
The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .
AlgorithmsConfig should not be set in AUTO training mode.
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, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.
When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.
For the list of all algorithms per training mode, see AutoMLAlgorithmConfig.
For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.
', 'CandidateGenerationConfig$AlgorithmsConfig' => 'Stores the configuration information for the selection of algorithms used to train model candidates 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 in AUTO training mode.
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.
', ], ], 'AutoMLCandidate' => [ 'base' => 'Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.
', 'refs' => [ 'AutoMLCandidates$member' => NULL, 'DescribeAutoMLJobResponse$BestCandidate' => 'The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.
', 'DescribeAutoMLJobV2Response$BestCandidate' => 'Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.
', ], ], 'AutoMLCandidateGenerationConfig' => [ 'base' => 'Stores the configuration information for how a candidate is generated (optional).
', 'refs' => [ 'AutoMLJobConfig$CandidateGenerationConfig' => 'The configuration for generating a candidate for an AutoML job (optional).
', ], ], 'AutoMLCandidateStep' => [ 'base' => 'Information about the steps for a candidate and what step it is working on.
', 'refs' => [ 'CandidateSteps$member' => NULL, ], ], 'AutoMLCandidates' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobResponse$Candidates' => 'Summaries about the AutoMLCandidates.
A 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 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.
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.
A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.
', 'refs' => [ 'AutoMLContainerDefinitions$member' => NULL, ], ], 'AutoMLContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$InferenceContainers' => 'Information about the recommended inference container definitions.
', 'AutoMLInferenceContainerDefinitions$value' => 'Information about the recommended inference container definitions.
', ], ], 'AutoMLDataSource' => [ 'base' => 'The data source for the Autopilot job.
', 'refs' => [ 'AutoMLChannel$DataSource' => 'The data source for an AutoML channel.
', 'AutoMLJobChannel$DataSource' => 'The data source for an AutoML channel (Required).
', ], ], 'AutoMLDataSplitConfig' => [ 'base' => '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.
The configuration for splitting the input training dataset.
Type: AutoMLDataSplitConfig
', 'CreateAutoMLJobV2Request$DataSplitConfig' => '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.
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.
Returns the configuration settings of how the data are split into train and validation datasets.
', ], ], 'AutoMLFailureReason' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$FailureReason' => 'The failure reason.
', 'AutoMLJobSummary$FailureReason' => 'The failure reason of an AutoML job.
', 'AutoMLPartialFailureReason$PartialFailureMessage' => 'The message containing the reason for a partial failure of an AutoML job.
', 'DescribeAutoMLJobResponse$FailureReason' => 'Returns the failure reason for an AutoML job, when applicable.
', 'DescribeAutoMLJobV2Response$FailureReason' => 'Returns the reason for the failure of the AutoML job V2, when applicable.
', ], ], 'AutoMLInferenceContainerDefinitions' => [ 'base' => '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 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.
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.
Returns the input data configuration for the AutoML job.
', ], ], 'AutoMLJobArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the AutoML job.
', 'AutoMLJobSummary$AutoMLJobArn' => 'The ARN of the AutoML job.
', 'CreateAutoMLJobResponse$AutoMLJobArn' => 'The unique ARN assigned to the AutoML job when it is created.
', 'CreateAutoMLJobV2Response$AutoMLJobArn' => 'The unique ARN assigned to the AutoMLJob when it is created.
', 'DescribeAutoMLJobResponse$AutoMLJobArn' => 'Returns the ARN of the AutoML job.
', 'DescribeAutoMLJobV2Response$AutoMLJobArn' => 'Returns the Amazon Resource Name (ARN) of the AutoML job V2.
', 'DescribeProcessingJobResponse$AutoMLJobArn' => 'The ARN of an AutoML job associated with this processing job.
', 'DescribeTrainingJobResponse$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of an AutoML job.
', 'DescribeTransformJobResponse$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of the AutoML transform job.
', 'ProcessingJob$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
', 'TrainingJob$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of the job.
', 'TransformJob$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
', ], ], 'AutoMLJobArtifacts' => [ 'base' => 'The artifacts that are generated during an AutoML job.
', 'refs' => [ 'DescribeAutoMLJobResponse$AutoMLJobArtifacts' => 'Returns information on the job\'s artifacts found in AutoMLJobArtifacts.
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).
', 'refs' => [ 'AutoMLJobInputDataConfig$member' => NULL, ], ], 'AutoMLJobCompletionCriteria' => [ 'base' => 'How long a job is allowed to run, or how many candidates a job is allowed to generate.
', 'refs' => [ 'AutoMLJobConfig$CompletionCriteria' => 'How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.
', 'AutoMLResolvedAttributes$CompletionCriteria' => NULL, 'ImageClassificationJobConfig$CompletionCriteria' => 'How long a job is allowed to run, or how many candidates a job is allowed to generate.
', 'ResolvedAttributes$CompletionCriteria' => NULL, 'TabularJobConfig$CompletionCriteria' => NULL, 'TextClassificationJobConfig$CompletionCriteria' => 'How long a job is allowed to run, or how many candidates a job is allowed to generate.
', 'TimeSeriesForecastingJobConfig$CompletionCriteria' => NULL, ], ], 'AutoMLJobConfig' => [ 'base' => 'A collection of settings used for an AutoML job.
', 'refs' => [ 'CreateAutoMLJobRequest$AutoMLJobConfig' => 'A collection of settings used to configure an AutoML job.
', 'DescribeAutoMLJobResponse$AutoMLJobConfig' => 'Returns the configuration for the AutoML job.
', ], ], 'AutoMLJobInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLJobInputDataConfig' => '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.
Returns an array of channel objects describing the input data and their location.
', ], ], 'AutoMLJobName' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobName' => 'The name of the AutoML job you are requesting.
', 'CreateAutoMLJobRequest$AutoMLJobName' => 'Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
', 'CreateAutoMLJobV2Request$AutoMLJobName' => 'Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
', 'DescribeAutoMLJobRequest$AutoMLJobName' => 'Requests information about an AutoML job using its unique name.
', 'DescribeAutoMLJobResponse$AutoMLJobName' => 'Returns the name of the AutoML job.
', 'DescribeAutoMLJobV2Request$AutoMLJobName' => 'Requests information about an AutoML job V2 using its unique name.
', 'DescribeAutoMLJobV2Response$AutoMLJobName' => 'Returns the name of the AutoML job V2.
', 'ListCandidatesForAutoMLJobRequest$AutoMLJobName' => 'List the candidates created for the job by providing the job\'s name.
', 'StopAutoMLJobRequest$AutoMLJobName' => 'The name of the object you are requesting.
', ], ], 'AutoMLJobObjective' => [ 'base' => 'Specifies a metric to minimize or maximize as the objective of a job.
', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLJobObjective' => NULL, 'CreateAutoMLJobRequest$AutoMLJobObjective' => '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.
', 'CreateAutoMLJobV2Request$AutoMLJobObjective' => '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.
Returns the job\'s objective.
', 'DescribeAutoMLJobV2Response$AutoMLJobObjective' => 'Returns the job\'s objective.
', 'ResolvedAttributes$AutoMLJobObjective' => NULL, ], ], 'AutoMLJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Type' => 'The type of metric with the best result.
', ], ], 'AutoMLJobSecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobSecondaryStatus' => 'The secondary status of the AutoML job.
', 'DescribeAutoMLJobResponse$AutoMLJobSecondaryStatus' => 'Returns the secondary status of the AutoML job.
', 'DescribeAutoMLJobV2Response$AutoMLJobSecondaryStatus' => 'Returns the secondary status of the AutoML job V2.
', ], ], 'AutoMLJobStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobStatus' => 'The status of the AutoML job.
', 'DescribeAutoMLJobResponse$AutoMLJobStatus' => 'Returns the status of the AutoML job.
', 'DescribeAutoMLJobV2Response$AutoMLJobStatus' => 'Returns the status of the AutoML job V2.
', 'ListAutoMLJobsRequest$StatusEquals' => 'Request a list of jobs, using a filter for status.
', ], ], 'AutoMLJobStepMetadata' => [ 'base' => 'Metadata for an AutoML job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$AutoMLJob' => 'The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
', ], ], 'AutoMLJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsResponse$AutoMLJobSummaries' => 'Returns a summary list of jobs.
', ], ], 'AutoMLJobSummary' => [ 'base' => 'Provides a summary about an AutoML job.
', 'refs' => [ 'AutoMLJobSummaries$member' => NULL, ], ], 'AutoMLMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$MaxResults' => 'Request a list of jobs up to a specified limit.
', 'ListCandidatesForAutoMLJobRequest$MaxResults' => 'List the job\'s candidates up to a specified limit.
', ], ], 'AutoMLMetricEnum' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobObjective$MetricName' => '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.
For the list of all available metrics supported by Autopilot, see Autopilot metrics.
If you do not specify a metric explicitly, the default behavior is to automatically use:
For tabular problem types:
Regression: MSE.
Binary classification: F1.
Multiclass classification: Accuracy.
For image or text classification problem types: Accuracy
For time-series forecasting problem types: AverageWeightedQuantileLoss
The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
', 'FinalAutoMLJobObjectiveMetric$StandardMetricName' => 'The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
', 'MetricDatum$MetricName' => 'The name of the metric.
', ], ], 'AutoMLMetricExtendedEnum' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$StandardMetricName' => 'The name of the standard metric.
For definitions of the standard metrics, see Autopilot candidate metrics .
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 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.
Request a list of jobs, using a search filter for name.
', ], ], 'AutoMLOutputDataConfig' => [ 'base' => 'The output data configuration.
', 'refs' => [ 'CreateAutoMLJobRequest$OutputDataConfig' => 'Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.
', 'CreateAutoMLJobV2Request$OutputDataConfig' => 'Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.
', 'DescribeAutoMLJobResponse$OutputDataConfig' => 'Returns the job\'s output data config.
', 'DescribeAutoMLJobV2Response$OutputDataConfig' => 'Returns the job\'s output data config.
', ], ], 'AutoMLPartialFailureReason' => [ 'base' => 'The reason for a partial failure of an AutoML job.
', 'refs' => [ 'AutoMLPartialFailureReasons$member' => NULL, ], ], 'AutoMLPartialFailureReasons' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$PartialFailureReasons' => 'The list of reasons for partial failures within an AutoML job.
', 'DescribeAutoMLJobResponse$PartialFailureReasons' => 'Returns a list of reasons for partial failures within an AutoML job.
', 'DescribeAutoMLJobV2Response$PartialFailureReasons' => 'Returns a list of reasons for partial failures within an AutoML job V2.
', ], ], 'AutoMLProblemTypeConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLProblemTypeConfig' => 'Defines the configuration settings of one of the supported problem types.
', 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfig' => 'Returns the configuration settings of the problem type set for the AutoML job V2.
', ], ], 'AutoMLProblemTypeConfigName' => [ 'base' => NULL, 'refs' => [ 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfigName' => 'Returns the name of the problem type configuration set for the AutoML job V2.
', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'base' => 'The resolved attributes specific to the problem type of an AutoML job V2.
', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLProblemTypeResolvedAttributes' => 'Defines the resolved attributes specific to a problem type.
', ], ], 'AutoMLProcessingUnit' => [ 'base' => NULL, 'refs' => [ 'AutoMLInferenceContainerDefinitions$key' => 'Processing unit for an inference container. Currently Autopilot only supports CPU or GPU.
The resolved attributes used to configure an AutoML job V2.
', 'refs' => [ 'DescribeAutoMLJobV2Response$ResolvedAttributes' => 'Returns the resolved attributes used by the AutoML job V2.
', ], ], 'AutoMLS3DataSource' => [ 'base' => 'Describes the Amazon S3 data source.
', 'refs' => [ 'AutoMLDataSource$S3DataSource' => 'The Amazon S3 location of the input data.
', ], ], 'AutoMLS3DataType' => [ 'base' => NULL, 'refs' => [ 'AutoMLS3DataSource$S3DataType' => 'The data type.
If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker 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 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.
Security options.
', 'refs' => [ 'AutoMLJobConfig$SecurityConfig' => 'The security configuration for traffic encryption or Amazon VPC settings.
', 'CreateAutoMLJobV2Request$SecurityConfig' => 'The security configuration for traffic encryption or Amazon VPC settings.
', 'DescribeAutoMLJobV2Response$SecurityConfig' => 'Returns the security configuration for traffic encryption or Amazon VPC settings.
', ], ], 'AutoMLSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortBy' => 'The parameter by which to sort the results. The default is Name.
The sort order for the results. The default is Descending.
The sort order for the results. The default is Ascending.
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.
', 'refs' => [ 'AutoParameters$member' => NULL, ], ], 'AutoParameters' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$AutoParameters' => 'A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.
', ], ], 'AutoRollbackConfig' => [ 'base' => 'Automatic rollback configuration for handling endpoint deployment failures and recovery.
', 'refs' => [ 'DeploymentConfig$AutoRollbackConfiguration' => 'Automatic rollback configuration for handling endpoint deployment failures and recovery.
', ], ], 'Autotune' => [ 'base' => 'A 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.
Configures 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.
A flag to indicate if autotune is enabled for the hyperparameter tuning job.
', ], ], 'AutotuneMode' => [ 'base' => NULL, 'refs' => [ 'Autotune$Mode' => 'Set Mode to Enabled if you want to use Autotune.
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:
', ], ], 'BacktestResultsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$BacktestResults' => '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.
', ], ], 'BatchDataCaptureConfig' => [ 'base' => 'Configuration to control how SageMaker captures inference data for batch transform jobs.
', 'refs' => [ 'CreateTransformJobRequest$DataCaptureConfig' => 'Configuration to control how SageMaker captures inference data.
', 'DescribeTransformJobResponse$DataCaptureConfig' => 'Configuration to control how SageMaker captures inference data.
', ], ], 'BatchDescribeModelPackageError' => [ 'base' => 'The error code and error description associated with the resource.
', 'refs' => [ 'BatchDescribeModelPackageErrorMap$value' => NULL, ], ], 'BatchDescribeModelPackageErrorMap' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$BatchDescribeModelPackageErrorMap' => 'A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.
', ], ], 'BatchDescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageSummary' => [ 'base' => 'Provides summary information about the model package.
', 'refs' => [ 'ModelPackageSummaries$value' => NULL, ], ], 'BatchStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$BatchStrategy' => '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.
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.
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.
', 'TransformJobDefinition$BatchStrategy' => '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.
Input object for the batch transform job.
', 'refs' => [ 'DataQualityJobInput$BatchTransformInput' => 'Input object for the batch transform job.
', 'ModelBiasJobInput$BatchTransformInput' => 'Input object for the batch transform job.
', 'ModelExplainabilityJobInput$BatchTransformInput' => 'Input object for the batch transform job.
', 'ModelQualityJobInput$BatchTransformInput' => 'Input object for the batch transform job.
', 'MonitoringInput$BatchTransformInput' => 'Input object for the batch transform job.
', ], ], 'BestObjectiveNotImproving' => [ 'base' => '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.
', 'refs' => [ 'TuningJobCompletionCriteria$BestObjectiveNotImproving' => 'A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.
', ], ], 'Bias' => [ 'base' => 'Contains bias metrics for a model.
', 'refs' => [ 'ModelMetrics$Bias' => 'Metrics that measure bais in a model.
', ], ], 'BillableTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$BillableTimeInSeconds' => '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%.
The billable time in seconds.
', ], ], 'BlockedReason' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreStatus$BlockedReason' => 'The justification for why the OfflineStoreStatus is Blocked (if applicable).
', ], ], 'BlueGreenUpdatePolicy' => [ 'base' => '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.
', 'refs' => [ 'DeploymentConfig$BlueGreenUpdatePolicy' => '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.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$EnableSageMakerMetricsTimeSeries' => 'To 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
Whether to use traffic encryption between the container layers.
', 'BatchDataCaptureConfig$GenerateInferenceId' => 'Flag that indicates whether to append inference id to the output.
', 'ChannelSpecification$IsRequired' => 'Indicates whether the channel is required by the algorithm.
', 'ClarifyCheckStepMetadata$SkipCheck' => '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 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.
Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
', 'CreateTrainingJobRequest$EnableNetworkIsolation' => '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.
', 'CreateTrainingJobRequest$EnableInterContainerTrafficEncryption' => '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 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.
', 'DescribeModelOutput$EnableNetworkIsolation' => 'If True, no inbound or outbound network calls can be made to or from the model container.
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, 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 not (False).
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
', 'HyperParameterSpecification$IsRequired' => 'Indicates whether this hyperparameter is required.
', 'HyperParameterTrainingJobDefinition$EnableNetworkIsolation' => '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.
', 'HyperParameterTrainingJobDefinition$EnableInterContainerTrafficEncryption' => '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 not (False).
Toggle for excluding devices deployed in other stages.
', 'Model$EnableNetworkIsolation' => 'Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
', 'ModelDashboardIndicatorAction$Enabled' => 'Indicates whether the alert action is turned on.
', 'MonitoringCsvDatasetFormat$Header' => 'Indicates if the CSV data has a header.
', 'MonitoringJsonDatasetFormat$Line' => 'Indicates if the file should be read as a json object per line.
', 'MonitoringNetworkConfig$EnableInterContainerTrafficEncryption' => '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 the monitoring job.
', 'NetworkConfig$EnableInterContainerTrafficEncryption' => '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 the processing job.
', 'OfflineStoreConfig$DisableGlueTableCreation' => '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.
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.
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 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.
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.
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, 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 training jobs instead of on-demand instances. For more information, see Managed Spot Training.
', 'TrainingSpecification$SupportsDistributedTraining' => 'Indicates whether the algorithm supports distributed training. If set to false, buyers can\'t request more than one instance during training.
', 'UpdateEndpointInput$RetainAllVariantProperties' => '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.
Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
', ], ], 'BooleanOperator' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$Operator' => '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.
The default branch for the Git repository.
', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$Bucket' => 'Name of the S3 bucket.
', ], ], 'CacheHitResult' => [ 'base' => 'Details on the cache hit of a pipeline execution step.
', 'refs' => [ 'PipelineExecutionStep$CacheHitResult' => 'If this pipeline execution step was cached, details on the cache hit.
', ], ], 'CallbackStepMetadata' => [ 'base' => 'Metadata about a callback step.
', 'refs' => [ 'PipelineExecutionStepMetadata$Callback' => 'The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.
', ], ], 'CallbackToken' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$CallbackToken' => 'The pipeline generated token from the Amazon SQS queue.
', 'SendPipelineExecutionStepFailureRequest$CallbackToken' => 'The pipeline generated token from the Amazon SQS queue.
', 'SendPipelineExecutionStepSuccessRequest$CallbackToken' => 'The pipeline generated token from the Amazon SQS queue.
', ], ], 'CandidateArtifactLocations' => [ 'base' => 'The location of artifacts for an AutoML candidate job.
', 'refs' => [ 'CandidateProperties$CandidateArtifactLocations' => 'The Amazon S3 prefix to the artifacts generated for an AutoML candidate.
', ], ], 'CandidateDefinitionNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$CandidateDefinitionNotebookLocation' => 'The URL of the notebook location.
', ], ], 'CandidateGenerationConfig' => [ 'base' => 'Stores the configuration information for how model candidates are generated using an AutoML job V2.
', 'refs' => [ 'TabularJobConfig$CandidateGenerationConfig' => 'The configuration information of how model candidates are generated.
', ], ], 'CandidateName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateName' => 'The name of the candidate.
', 'ListCandidatesForAutoMLJobRequest$CandidateNameEquals' => 'List the candidates for the job and filter by candidate name.
', ], ], 'CandidateProperties' => [ 'base' => 'The properties of an AutoML candidate job.
', 'refs' => [ 'AutoMLCandidate$CandidateProperties' => 'The properties of an AutoML candidate job.
', ], ], 'CandidateSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$SortBy' => 'The parameter by which to sort the results. The default is Descending.
The candidate\'s status.
', 'ListCandidatesForAutoMLJobRequest$StatusEquals' => 'List the candidates for the job and filter by status.
', ], ], 'CandidateStepArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepArn' => 'The ARN for the candidate\'s step.
', ], ], 'CandidateStepName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepName' => 'The name for the candidate\'s step.
', ], ], 'CandidateStepType' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepType' => 'Whether the candidate is at the transform, training, or processing step.
', ], ], 'CandidateSteps' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateSteps' => 'Information about the candidate\'s steps.
', ], ], 'CanvasAppSettings' => [ 'base' => 'The SageMaker Canvas application settings.
', 'refs' => [ 'UserSettings$CanvasAppSettings' => 'The Canvas app settings.
', ], ], 'CapacitySize' => [ 'base' => '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.
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.
', 'RollingUpdatePolicy$RollbackMaximumBatchSize' => '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.
', 'TrafficRoutingConfig$CanarySize' => '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. Value must be 10-50% of the variant\'s total instance count.
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 percentage.
', ], ], 'CaptureContentTypeHeader' => [ 'base' => 'Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.
', 'refs' => [ 'DataCaptureConfig$CaptureContentTypeHeader' => 'Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.
', 'InferenceExperimentDataStorageConfig$ContentType' => NULL, ], ], 'CaptureMode' => [ 'base' => NULL, 'refs' => [ 'CaptureOption$CaptureMode' => 'Specify the boundary of data to capture.
', ], ], 'CaptureOption' => [ 'base' => 'Specifies data Model Monitor will capture.
', 'refs' => [ 'CaptureOptionList$member' => NULL, ], ], 'CaptureOptionList' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$CaptureOptions' => 'Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both
', ], ], 'CaptureStatus' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfigSummary$CaptureStatus' => 'Whether data capture is currently functional.
', ], ], 'Catalog' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Catalog' => 'The name of the Glue table catalog.
', ], ], 'CategoricalParameter' => [ 'base' => 'Environment parameters you want to benchmark your load test against.
', 'refs' => [ 'CategoricalParameters$member' => NULL, ], ], 'CategoricalParameterRange' => [ 'base' => 'A list of categorical hyperparameters to tune.
', 'refs' => [ 'CategoricalParameterRanges$member' => NULL, ], ], 'CategoricalParameterRangeSpecification' => [ 'base' => 'Defines the possible values for a categorical hyperparameter.
', 'refs' => [ 'ParameterRange$CategoricalParameterRangeSpecification' => 'A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.
The list of values you can pass.
', ], ], 'CategoricalParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$CategoricalParameterRanges' => 'The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
', ], ], 'CategoricalParameters' => [ 'base' => NULL, 'refs' => [ 'EnvironmentParameterRanges$CategoricalParameterRanges' => 'Specified a list of parameters for each category.
', ], ], 'Cents' => [ 'base' => NULL, 'refs' => [ 'USD$Cents' => 'The fractional portion, in cents, of the amount.
', ], ], 'CertifyForMarketplace' => [ 'base' => NULL, 'refs' => [ 'CreateAlgorithmInput$CertifyForMarketplace' => 'Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.
', 'CreateModelPackageInput$CertifyForMarketplace' => '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.
', 'DescribeAlgorithmOutput$CertifyForMarketplace' => 'Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.
', 'DescribeModelPackageOutput$CertifyForMarketplace' => 'Whether the model package is certified for listing on Amazon Web Services Marketplace.
', 'ModelPackage$CertifyForMarketplace' => '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.
', ], ], 'Channel' => [ 'base' => 'A channel is a named input source that training algorithms can consume.
', 'refs' => [ 'InputDataConfig$member' => NULL, ], ], 'ChannelName' => [ 'base' => NULL, 'refs' => [ 'Channel$ChannelName' => 'The name of the channel.
', 'ChannelSpecification$Name' => 'The name of the channel.
', ], ], 'ChannelSpecification' => [ 'base' => 'Defines a named input source, called a channel, to be used by an algorithm.
', 'refs' => [ 'ChannelSpecifications$member' => NULL, ], ], 'ChannelSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$TrainingChannels' => 'A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.
Contains information about the output location for managed spot training checkpoint data.
', 'refs' => [ 'CreateTrainingJobRequest$CheckpointConfig' => 'Contains information about the output location for managed spot training checkpoint data.
', 'DescribeTrainingJobResponse$CheckpointConfig' => NULL, 'HyperParameterTrainingJobDefinition$CheckpointConfig' => NULL, 'TrainingJob$CheckpointConfig' => NULL, ], ], 'Cidr' => [ 'base' => NULL, 'refs' => [ 'Cidrs$member' => NULL, ], ], 'Cidrs' => [ 'base' => NULL, 'refs' => [ 'SourceIpConfig$Cidrs' => 'A 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.
The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.
', 'refs' => [ 'PipelineExecutionStepMetadata$ClarifyCheck' => '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.
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.
A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.
The configuration parameters for the SageMaker Clarify explainer.
', 'refs' => [ 'ExplainerConfig$ClarifyExplainerConfig' => 'A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.
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 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.
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]}\'.
The inference configuration parameter for the model container.
', 'refs' => [ 'ClarifyExplainerConfig$InferenceConfig' => 'The inference configuration parameter for the model container.
', ], ], 'ClarifyLabelAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelAttribute' => '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 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.
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\'].
The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.
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 MIME type of the baseline data. Choose from \'text/csv\' or \'application/jsonlines\'. Defaults to \'text/csv\'.
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 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].
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 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 configuration for the SHAP baseline of the Kernal SHAP algorithm.
', ], ], 'ClarifyShapConfig' => [ 'base' => 'The configuration for SHAP analysis using SageMaker Clarify Explainer.
', 'refs' => [ 'ClarifyExplainerConfig$ShapConfig' => 'The configuration for SHAP analysis.
', ], ], 'ClarifyShapNumberOfSamples' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$NumberOfSamples' => 'The 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.
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.
', ], ], 'ClarifyShapUseLogit' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$UseLogit' => '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.
', ], ], 'ClarifyTextConfig' => [ 'base' => '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.
', 'refs' => [ 'ClarifyShapConfig$TextConfig' => '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.
', ], ], 'ClarifyTextGranularity' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Granularity' => '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.
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 client ID for your Amazon Cognito user pool.
', 'CognitoMemberDefinition$ClientId' => 'An identifier for an application client. You must create the app client ID using Amazon Cognito.
', 'OidcConfig$ClientId' => 'The OIDC IdP client ID used to configure your private workforce.
', 'OidcConfigForResponse$ClientId' => 'The OIDC IdP client ID used to configure your private workforce.
', ], ], 'ClientSecret' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$ClientSecret' => 'The OIDC IdP client secret used to configure your private workforce.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ClientToken' => '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.
', 'CreateModelPackageInput$ClientToken' => 'A unique token that guarantees that the call to this API is idempotent.
', ], ], 'CodeRepositories' => [ 'base' => NULL, 'refs' => [ 'JupyterServerAppSettings$CodeRepositories' => 'A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.
', ], ], 'CodeRepository' => [ 'base' => 'A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.
', 'refs' => [ 'CodeRepositories$member' => NULL, ], ], 'CodeRepositoryArn' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$CodeRepositoryArn' => 'The Amazon Resource Name (ARN) of the Git repository.
', 'CreateCodeRepositoryOutput$CodeRepositoryArn' => 'The Amazon Resource Name (ARN) of the new repository.
', 'DescribeCodeRepositoryOutput$CodeRepositoryArn' => 'The Amazon Resource Name (ARN) of the Git repository.
', 'UpdateCodeRepositoryOutput$CodeRepositoryArn' => 'The ARN of the Git repository.
', ], ], 'CodeRepositoryContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$DefaultCodeRepositoryContains' => '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.
', ], ], 'CodeRepositoryNameContains' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$NameContains' => 'A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.
', ], ], 'CodeRepositoryNameOrUrl' => [ 'base' => NULL, 'refs' => [ 'AdditionalCodeRepositoryNamesOrUrls$member' => NULL, 'CreateNotebookInstanceInput$DefaultCodeRepository' => '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 Notebook Instances.
', 'DescribeNotebookInstanceOutput$DefaultCodeRepository' => '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 Notebook Instances.
', 'ListNotebookInstancesInput$AdditionalCodeRepositoryEquals' => 'A filter that returns only notebook instances with associated with the specified git repository.
', 'NotebookInstanceSummary$DefaultCodeRepository' => '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 Notebook Instances.
', 'UpdateNotebookInstanceInput$DefaultCodeRepository' => '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 Notebook Instances.
', ], ], 'CodeRepositorySortBy' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortBy' => 'The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
Specifies summary information about a Git repository.
', 'refs' => [ 'CodeRepositorySummaryList$member' => NULL, ], ], 'CodeRepositorySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesOutput$CodeRepositorySummaryList' => 'Gets 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.
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.
', 'refs' => [ 'CreateWorkforceRequest$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.
The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
', ], ], 'CognitoMemberDefinition' => [ 'base' => 'Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.
', 'refs' => [ 'MemberDefinition$CognitoMemberDefinition' => 'The Amazon Cognito user group that is part of the work team.
', ], ], 'CognitoUserGroup' => [ 'base' => NULL, 'refs' => [ 'CognitoMemberDefinition$UserGroup' => 'An identifier for a user group.
', ], ], 'CognitoUserPool' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$UserPool' => '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.
', 'CognitoMemberDefinition$UserPool' => 'An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
', ], ], 'CollectionConfiguration' => [ 'base' => 'Configuration information for the Amazon SageMaker Debugger output tensor collections.
', 'refs' => [ 'CollectionConfigurations$member' => NULL, ], ], 'CollectionConfigurations' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$CollectionConfigurations' => '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.
The name of the tensor collection. The name must be unique relative to other rule configuration names.
', ], ], 'CollectionParameters' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionParameters' => 'Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".
The Amazon Resource Name (ARN) of the model compilation job.
', 'CreateCompilationJobResponse$CompilationJobArn' => 'If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:
CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.
The Amazon Resource Name (ARN) of the model compilation job.
', ], ], 'CompilationJobStatus' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobStatus' => 'The status of the model compilation job.
', 'DescribeCompilationJobResponse$CompilationJobStatus' => 'The status of the model compilation job.
', 'ListCompilationJobsRequest$StatusEquals' => 'A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.
An array of CompilationJobSummary objects, each describing a model compilation job.
', ], ], 'CompilationJobSummary' => [ 'base' => 'A summary of a model compilation job.
', 'refs' => [ 'CompilationJobSummaries$member' => NULL, ], ], 'CompilerOptions' => [ 'base' => NULL, 'refs' => [ 'OutputConfig$CompilerOptions' => '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.
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.
EIA: Compilation for the Elastic Inference Accelerator supports the following compiler options:
precision_mode: Specifies the precision of compiled artifacts. Supported values are "FP16" and "FP32". Default is "FP32".
signature_def_key: Specifies the signature to use for models in SavedModel format. Defaults is TensorFlow\'s default signature def key.
output_names: Specifies a list of output tensor names for models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.
For example: {"precision_mode": "FP32", "output_names": ["output:0"]}
A flag to stop a tuning job once AMT has detected that the job has converged.
', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$CompressionType' => 'You can use Gzip or None. The default value is 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.
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.
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 allowed compression types, if data compression is used.
', ], ], 'ConditionOutcome' => [ 'base' => NULL, 'refs' => [ 'ConditionStepMetadata$Outcome' => 'The outcome of the Condition step evaluation.
', ], ], 'ConditionStepMetadata' => [ 'base' => 'Metadata for a Condition step.
', 'refs' => [ 'PipelineExecutionStepMetadata$Condition' => 'The outcome of the condition evaluation that was run by this step execution.
', ], ], 'ConfigKey' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$key' => NULL, 'HookParameters$key' => NULL, 'ProfilingParameters$key' => NULL, 'RuleParameters$key' => NULL, ], ], 'ConfigValue' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$value' => NULL, 'HookParameters$value' => NULL, 'ProfilingParameters$value' => NULL, 'RuleParameters$value' => NULL, ], ], 'ConflictException' => [ 'base' => 'There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
The arguments for a container used to run a processing job.
', ], ], 'ContainerDefinition' => [ 'base' => 'Describes the container, as part of model definition.
', 'refs' => [ 'ContainerDefinitionList$member' => NULL, 'CreateModelInput$PrimaryContainer' => '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.
', 'DescribeModelOutput$PrimaryContainer' => 'The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
', 'Model$PrimaryContainer' => NULL, ], ], 'ContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$Containers' => 'Specifies the containers in the inference pipeline.
', 'DescribeModelOutput$Containers' => 'The containers in the inference pipeline.
', 'Model$Containers' => 'The containers in the inference pipeline.
', ], ], 'ContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerEntrypoint' => 'The entrypoint for a container used to run a processing job.
', 'DataQualityAppSpecification$ContainerEntrypoint' => 'The entrypoint for a container used to run a monitoring job.
', 'ModelQualityAppSpecification$ContainerEntrypoint' => 'Specifies the entrypoint for a container that the monitoring job runs.
', 'MonitoringAppSpecification$ContainerEntrypoint' => 'Specifies the entrypoint for a container used to run the monitoring job.
', ], ], 'ContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'ContainerEntrypoint$member' => NULL, ], ], 'ContainerHostname' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ContainerHostname' => '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 DNS host name for the Docker container.
', ], ], 'ContainerImage' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Image' => 'The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.
', 'ContainerDefinition$Image' => 'The 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.
The image path you specified when you created the model.
', 'DeployedImage$ResolvedImage' => 'The specific digest path of the image hosted in this ProductionVariant.
The Amazon EC2 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.
The Amazon ECR registry path of the Docker image that contains the training algorithm.
', ], ], 'ContainerMode' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$Mode' => 'Whether the container hosts a single model or multiple models.
', ], ], 'ContentClassifier' => [ 'base' => NULL, 'refs' => [ 'ContentClassifiers$member' => NULL, ], ], 'ContentClassifiers' => [ 'base' => NULL, 'refs' => [ 'LabelingJobDataAttributes$ContentClassifiers' => '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.
', ], ], 'ContentColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$ContentColumn' => 'The name of the column used to provide the sentences to be classified. It should not be the same as the target column.
', ], ], 'ContentDigest' => [ 'base' => NULL, 'refs' => [ 'FileSource$ContentDigest' => 'The digest of the file source.
', 'MetricsSource$ContentDigest' => 'The hash key used for the metrics source.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ContentType' => '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 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.
The MIME type of the data.
', 'ContentTypes$member' => NULL, 'FileSource$ContentType' => 'The type of content stored in the file source.
', 'MetricsSource$ContentType' => 'The metric source content type.
', 'TransformInput$ContentType' => '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.
', ], ], 'ContentTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedContentTypes' => 'The supported MIME types for the input data.
', 'ChannelSpecification$SupportedContentTypes' => 'The supported MIME types for the data.
', 'InferenceSpecification$SupportedContentTypes' => 'The supported MIME types for the input data.
', ], ], 'ContextArn' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', 'CreateContextResponse$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', 'DeleteContextResponse$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', 'DescribeContextResponse$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', 'UpdateContextResponse$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', ], ], 'ContextSource' => [ 'base' => 'A structure describing the source of a context.
', 'refs' => [ 'ContextSummary$Source' => 'The source of the context.
', 'CreateContextRequest$Source' => 'The source type, ID, and URI.
', 'DescribeContextResponse$Source' => 'The source of the context.
', ], ], 'ContextSummaries' => [ 'base' => NULL, 'refs' => [ 'ListContextsResponse$ContextSummaries' => 'A list of contexts and their properties.
', ], ], 'ContextSummary' => [ 'base' => 'Lists a summary of the properties of a context. A context provides a logical grouping of other entities.
', 'refs' => [ 'ContextSummaries$member' => NULL, ], ], 'ContinuousParameterRange' => [ 'base' => 'A list of continuous hyperparameters to tune.
', 'refs' => [ 'ContinuousParameterRanges$member' => NULL, ], ], 'ContinuousParameterRangeSpecification' => [ 'base' => 'Defines the possible values for a continuous hyperparameter.
', 'refs' => [ 'ParameterRange$ContinuousParameterRangeSpecification' => 'A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.
The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
', ], ], 'ConvergenceDetected' => [ 'base' => '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.
', 'refs' => [ 'TuningJobCompletionCriteria$ConvergenceDetected' => '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.
', ], ], 'CreateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$CreationTime' => 'A timestamp that shows when the algorithm was created.
', 'AppDetails$CreationTime' => 'The creation time.
', 'BatchDescribeModelPackageSummary$CreationTime' => 'The creation time of the mortgage package summary.
', 'CodeRepositorySummary$CreationTime' => 'The date and time that the Git repository was created.
', 'CompilationJobSummary$CreationTime' => 'The time when the model compilation job was created.
', 'DescribeAlgorithmOutput$CreationTime' => 'A timestamp specifying when the algorithm was created.
', 'DescribeAppResponse$CreationTime' => 'The creation time.
', 'DescribeCodeRepositoryOutput$CreationTime' => 'The date and time that the repository was created.
', 'DescribeCompilationJobResponse$CreationTime' => 'The time that the model compilation job was created.
', 'DescribeDomainResponse$CreationTime' => 'The creation time.
', 'DescribeFeatureGroupResponse$CreationTime' => 'A timestamp indicating when SageMaker created the FeatureGroup.
A timestamp indicating when the feature was created.
', 'DescribeInferenceRecommendationsJobResponse$CreationTime' => 'A timestamp that shows when the job was created.
', 'DescribeModelPackageGroupOutput$CreationTime' => 'The time that the model group was created.
', 'DescribeModelPackageOutput$CreationTime' => 'A timestamp specifying when the model package was created.
', 'DescribeNotebookInstanceLifecycleConfigOutput$CreationTime' => 'A timestamp that tells when the lifecycle configuration was created.
', 'DescribeNotebookInstanceOutput$CreationTime' => 'A timestamp. Use this parameter to return the time when the notebook instance was created
', 'DescribeSpaceResponse$CreationTime' => 'The creation time.
', 'DescribeUserProfileResponse$CreationTime' => 'The creation time.
', 'DomainDetails$CreationTime' => 'The creation time.
', 'FeatureGroup$CreationTime' => 'The time a FeatureGroup was created.
A timestamp indicating when the feature was created.
', 'InferenceRecommendationsJob$CreationTime' => 'A timestamp that shows when the job was created.
', 'ListAlgorithmsInput$CreationTimeAfter' => 'A filter that returns only algorithms created after the specified time (timestamp).
', 'ListAlgorithmsInput$CreationTimeBefore' => 'A filter that returns only algorithms created before the specified time (timestamp).
', 'ListCodeRepositoriesInput$CreationTimeAfter' => 'A filter that returns only Git repositories that were created after the specified time.
', 'ListCodeRepositoriesInput$CreationTimeBefore' => 'A filter that returns only Git repositories that were created before the specified time.
', 'ListCompilationJobsRequest$CreationTimeAfter' => 'A filter that returns the model compilation jobs that were created after a specified time.
', 'ListCompilationJobsRequest$CreationTimeBefore' => 'A filter that returns the model compilation jobs that were created before a specified time.
', 'ListFeatureGroupsRequest$CreationTimeAfter' => '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 date and time.
A filter that returns only jobs created after the specified time (timestamp).
', 'ListInferenceRecommendationsJobsRequest$CreationTimeBefore' => 'A filter that returns only jobs created before the specified time (timestamp).
', 'ListModelPackageGroupsInput$CreationTimeAfter' => 'A filter that returns only model groups created after the specified time.
', 'ListModelPackageGroupsInput$CreationTimeBefore' => 'A filter that returns only model groups created before the specified time.
', 'ListModelPackagesInput$CreationTimeAfter' => 'A filter that returns only model packages created after the specified time (timestamp).
', 'ListModelPackagesInput$CreationTimeBefore' => 'A filter that returns only model packages created before the specified time (timestamp).
', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeBefore' => 'A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeAfter' => 'A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
', 'ListNotebookInstancesInput$CreationTimeBefore' => 'A filter that returns only notebook instances that were created before the specified time (timestamp).
', 'ListNotebookInstancesInput$CreationTimeAfter' => 'A filter that returns only notebook instances that were created after the specified time (timestamp).
', 'ModelPackage$CreationTime' => 'The time that the model package was created.
', 'ModelPackageGroup$CreationTime' => 'The time that the model group was created.
', 'ModelPackageGroupSummary$CreationTime' => 'The time that the model group was created.
', 'ModelPackageSummary$CreationTime' => 'A timestamp that shows when the model package was created.
', 'NotebookInstanceLifecycleConfigSummary$CreationTime' => 'A timestamp that tells when the lifecycle configuration was created.
', 'NotebookInstanceSummary$CreationTime' => 'A timestamp that shows when the notebook instance was created.
', 'SpaceDetails$CreationTime' => 'The creation time.
', 'UserProfileDetails$CreationTime' => 'The creation time.
', ], ], 'CrossAccountFilterOption' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$CrossAccountFilterOption' => ' 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.
The list of all content type headers that SageMaker will treat as CSV and capture accordingly.
', ], ], 'CustomImage' => [ 'base' => 'A custom SageMaker image. For more information, see Bring your own SageMaker image.
', 'refs' => [ 'CustomImages$member' => NULL, ], ], 'CustomImages' => [ 'base' => NULL, 'refs' => [ 'KernelGatewayAppSettings$CustomImages' => 'A list of custom SageMaker images that are configured to run as a KernelGateway app.
', 'RSessionAppSettings$CustomImages' => 'A list of custom SageMaker images that are configured to run as a RSession app.
', ], ], 'CustomerMetadataKey' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataKeyList$member' => NULL, 'CustomerMetadataMap$key' => NULL, ], ], 'CustomerMetadataKeyList' => [ 'base' => NULL, 'refs' => [ 'UpdateModelPackageInput$CustomerMetadataPropertiesToRemove' => 'The metadata properties associated with the model package versions to remove.
', ], ], 'CustomerMetadataMap' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$CustomerMetadataProperties' => 'The metadata properties associated with the model package versions.
', 'DescribeModelPackageOutput$CustomerMetadataProperties' => 'The metadata properties associated with the model package versions.
', 'ModelPackage$CustomerMetadataProperties' => 'The metadata properties for the model package.
', 'UpdateModelPackageInput$CustomerMetadataProperties' => 'The metadata properties associated with the model package versions.
', ], ], 'CustomerMetadataValue' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataMap$value' => NULL, ], ], 'DataCaptureConfig' => [ 'base' => 'Configuration to control how SageMaker captures inference data.
', 'refs' => [ 'CreateEndpointConfigInput$DataCaptureConfig' => NULL, 'DescribeEndpointConfigOutput$DataCaptureConfig' => NULL, ], ], 'DataCaptureConfigSummary' => [ 'base' => 'The currently active data capture configuration used by your Endpoint.
', 'refs' => [ 'DescribeEndpointOutput$DataCaptureConfig' => NULL, 'Endpoint$DataCaptureConfig' => NULL, ], ], 'DataCatalogConfig' => [ 'base' => 'The meta data of the Glue table which serves as data catalog for the OfflineStore.
The meta data of the Glue table that is autogenerated when an OfflineStore is created.
Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
The URL of the notebook location.
', ], ], 'DataInputConfig' => [ 'base' => NULL, 'refs' => [ 'InputConfig$DataInputConfig' => '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"]}
The input configuration object for the model.
', ], ], 'DataProcessing' => [ 'base' => '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.
', 'refs' => [ 'CreateTransformJobRequest$DataProcessing' => '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.
', 'DescribeTransformJobResponse$DataProcessing' => NULL, 'TransformJob$DataProcessing' => NULL, ], ], 'DataQualityAppSpecification' => [ 'base' => 'Information about the container that a data quality monitoring job runs.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityAppSpecification' => 'Specifies the container that runs the monitoring job.
', 'DescribeDataQualityJobDefinitionResponse$DataQualityAppSpecification' => 'Information about the container that runs the data quality monitoring job.
', ], ], 'DataQualityBaselineConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityBaselineConfig' => 'Configures the constraints and baselines for the monitoring job.
', 'DescribeDataQualityJobDefinitionResponse$DataQualityBaselineConfig' => 'The constraints and baselines for the data quality monitoring job definition.
', ], ], 'DataQualityJobInput' => [ 'base' => 'The input for the data quality monitoring job. Currently endpoints are supported for input.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobInput' => 'A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.
', 'DescribeDataQualityJobDefinitionResponse$DataQualityJobInput' => 'The list of inputs for the data quality monitoring job. Currently endpoints are supported.
', ], ], 'DataSource' => [ 'base' => 'Describes the location of the channel data.
', 'refs' => [ 'Channel$DataSource' => 'The location of the channel data.
', ], ], 'Database' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Database' => 'The name of the Glue table database.
', ], ], 'DatasetDefinition' => [ 'base' => 'Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.
Configuration for a Dataset Definition input.
', ], ], 'DebugHookConfig' => [ 'base' => '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.
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.
Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
', 'DescribeTrainingJobResponse$DebugRuleConfigurations' => 'Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
', 'TrainingJob$DebugRuleConfigurations' => 'Information about the debug rule configuration.
', ], ], 'DebugRuleEvaluationStatus' => [ 'base' => 'Information about the status of the rule evaluation.
', 'refs' => [ 'DebugRuleEvaluationStatuses$member' => NULL, ], ], 'DebugRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$DebugRuleEvaluationStatuses' => 'Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.
', 'TrainingJob$DebugRuleEvaluationStatuses' => 'Information about the evaluation status of the rules for the training job.
', ], ], 'DefaultGid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultGid' => 'The default POSIX group ID (GID). If not specified, defaults to 100.
A collection of settings that apply to spaces created in the Domain.
', 'refs' => [ 'CreateDomainRequest$DefaultSpaceSettings' => 'The default settings used to create a space.
', 'DescribeDomainResponse$DefaultSpaceSettings' => 'The default settings used to create a space.
', 'UpdateDomainRequest$DefaultSpaceSettings' => 'The default settings used to create a space within the Domain.
', ], ], 'DefaultUid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultUid' => 'The default POSIX user ID (UID). If not specified, defaults to 1000.
The hub content dependency copy path.
', ], ], 'DependencyOriginPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyOriginPath' => 'The hub content dependency origin path.
', ], ], 'DeployedImage' => [ 'base' => '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.
An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the 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 deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
', 'refs' => [ 'CreateEndpointInput$DeploymentConfig' => NULL, 'DescribeEndpointOutput$LastDeploymentConfig' => 'The most recent deployment configuration for the endpoint.
', 'UpdateEndpointInput$DeploymentConfig' => 'The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
', ], ], 'DeploymentRecommendation' => [ 'base' => 'A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.
', 'refs' => [ 'DescribeModelOutput$DeploymentRecommendation' => 'A set of recommended deployment configurations for the model.
', 'Model$DeploymentRecommendation' => 'A set of recommended deployment configurations for the model.
', ], ], 'DeploymentStage' => [ 'base' => 'Contains information about a stage in an edge deployment plan.
', 'refs' => [ 'DeploymentStages$member' => NULL, ], ], 'DeploymentStageMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanRequest$MaxResults' => 'The maximum number of results to select (50 by default).
', ], ], 'DeploymentStageStatusSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanResponse$Stages' => 'List of stages in the edge deployment plan.
', ], ], 'DeploymentStageStatusSummary' => [ 'base' => 'Contains information summarizing the deployment stage results.
', 'refs' => [ 'DeploymentStageStatusSummaries$member' => NULL, ], ], 'DeploymentStages' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$Stages' => 'List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
', 'CreateEdgeDeploymentStageRequest$Stages' => 'List of stages to be added to the edge deployment plan.
', ], ], 'DeregisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$Description' => 'A free-form description of a FeatureGroup.
A free form description of the feature group.
', 'FeatureGroup$Description' => 'A free form description of a FeatureGroup.
Specifies weight and capacity values for a production variant.
', 'refs' => [ 'DesiredWeightAndCapacityList$member' => NULL, ], ], 'DesiredWeightAndCapacityList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointWeightsAndCapacitiesInput$DesiredWeightsAndCapacities' => 'An object that provides new capacity and weight values for a variant.
', ], ], 'DestinationS3Uri' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$S3OutputPath' => 'The Amazon S3 location to upload inference responses to.
', 'AsyncInferenceOutputConfig$S3FailurePath' => 'The Amazon S3 location to upload failure inference responses to.
', 'BatchTransformInput$DataCapturedDestinationS3Uri' => 'The Amazon S3 location being used to capture the data.
', 'DataCaptureConfig$DestinationS3Uri' => 'The Amazon S3 location used to capture the data.
', 'DataCaptureConfigSummary$DestinationS3Uri' => 'The Amazon S3 location being used to capture the data.
', 'InferenceExperimentDataStorageConfig$Destination' => 'The Amazon S3 bucket where the inference request and response data is stored.
', 'ProductionVariantCoreDumpConfig$DestinationS3Uri' => 'The Amazon S3 bucket to send the core dump to.
', ], ], 'DetailedAlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$Status' => 'The current status.
', ], ], 'DetailedModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusItem$Status' => 'The current status.
', ], ], 'Device' => [ 'base' => 'Information of a particular device.
', 'refs' => [ 'Devices$member' => NULL, ], ], 'DeviceArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$DeviceArn' => 'The Amazon Resource Name (ARN) of the device.
', 'DeviceDeploymentSummary$DeviceArn' => 'The ARN of the device.
', 'DeviceSummary$DeviceArn' => 'Amazon Resource Name (ARN) of the device.
', ], ], 'DeviceDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'DeviceDeploymentSummary$DeviceDeploymentStatus' => 'The deployment status of the device.
', ], ], 'DeviceDeploymentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStageDevicesResponse$DeviceDeploymentSummaries' => 'List of summaries of devices allocated to the stage.
', ], ], 'DeviceDeploymentSummary' => [ 'base' => 'Contains information summarizing device details and deployment status.
', 'refs' => [ 'DeviceDeploymentSummaries$member' => NULL, ], ], 'DeviceDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Description' => 'A description of the device.
', 'Device$Description' => 'Description of the device.
', 'DeviceDeploymentSummary$Description' => 'The description of the device.
', 'DeviceSummary$Description' => 'A description of the device.
', ], ], 'DeviceFleetArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$DeviceFleetArn' => 'The The Amazon Resource Name (ARN) of the fleet.
', 'DeviceFleetSummary$DeviceFleetArn' => 'Amazon Resource Name (ARN) of the device fleet.
', 'GetDeviceFleetReportResponse$DeviceFleetArn' => 'The Amazon Resource Name (ARN) of the device.
', ], ], 'DeviceFleetDescription' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$Description' => 'A description of the fleet.
', 'DescribeDeviceFleetResponse$Description' => 'A description of the fleet.
', 'GetDeviceFleetReportResponse$Description' => 'Description of the fleet.
', 'UpdateDeviceFleetRequest$Description' => 'Description of the fleet.
', ], ], 'DeviceFleetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsResponse$DeviceFleetSummaries' => 'Summary of the device fleet.
', ], ], 'DeviceFleetSummary' => [ 'base' => 'Summary of the device fleet.
', 'refs' => [ 'DeviceFleetSummaries$member' => NULL, ], ], 'DeviceName' => [ 'base' => NULL, 'refs' => [ 'Device$DeviceName' => 'The name of the device.
', 'DeviceDeploymentSummary$DeviceName' => 'The name of the device.
', 'DeviceNames$member' => NULL, 'DeviceSelectionConfig$DeviceNameContains' => 'A filter to select devices with names containing this name.
', ], ], 'DeviceNames' => [ 'base' => NULL, 'refs' => [ 'DeregisterDevicesRequest$DeviceNames' => 'The unique IDs of the devices.
', 'DeviceSelectionConfig$DeviceNames' => 'List of devices chosen to deploy.
', ], ], 'DeviceSelectionConfig' => [ 'base' => 'Contains information about the configurations of selected devices.
', 'refs' => [ 'DeploymentStage$DeviceSelectionConfig' => 'Configuration of the devices in the stage.
', 'DeploymentStageStatusSummary$DeviceSelectionConfig' => 'Configuration of the devices in the stage.
', ], ], 'DeviceStats' => [ 'base' => 'Status of devices.
', 'refs' => [ 'GetDeviceFleetReportResponse$DeviceStats' => 'Status of devices.
', ], ], 'DeviceSubsetType' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$DeviceSubsetType' => 'Type of device subsets to deploy to the current stage.
', ], ], 'DeviceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDevicesResponse$DeviceSummaries' => 'Summary of devices.
', ], ], 'DeviceSummary' => [ 'base' => 'Summary of the device.
', 'refs' => [ 'DeviceSummaries$member' => NULL, ], ], 'Devices' => [ 'base' => NULL, 'refs' => [ 'RegisterDevicesRequest$Devices' => 'A list of devices to register with SageMaker Edge Manager.
', 'UpdateDevicesRequest$Devices' => 'List of devices to register with Edge Manager agent.
', ], ], 'DirectInternetAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$DirectInternetAccess' => 'Sets whether SageMaker 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 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.
Describes whether SageMaker 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 training and endpoint services.
For more information, see Notebook Instances Are Internet-Enabled by Default.
', ], ], 'Direction' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$Direction' => 'Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
', ], ], 'DirectoryPath' => [ 'base' => NULL, 'refs' => [ 'CheckpointConfig$LocalPath' => '(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.
Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.
Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
The full path to the directory to associate with the channel.
', 'ProfilerRuleConfiguration$LocalPath' => 'Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.
Configuration to turn off Amazon SageMaker Debugger\'s system monitoring and profiling functionality. To turn it off, set to True.
To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.
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.
', ], ], 'DisassociateDefaultCodeRepository' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateDefaultCodeRepository' => '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.
', ], ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAcceleratorTypes' => 'A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.
', ], ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateLifecycleConfig' => '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 document schema version for the hub content.
', 'HubContentInfo$DocumentSchemaVersion' => 'The version of the hub content document schema.
', 'ImportHubContentRequest$DocumentSchemaVersion' => 'The version of the hub content schema to import.
', 'ListHubContentVersionsRequest$MaxSchemaVersion' => 'The upper bound of the hub content schema version.
', 'ListHubContentsRequest$MaxSchemaVersion' => 'The upper bound of the hub content schema verion.
', ], ], 'Dollars' => [ 'base' => NULL, 'refs' => [ 'USD$Dollars' => 'The whole number of dollars in the amount.
', ], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainResponse$DomainArn' => 'The Amazon Resource Name (ARN) of the created domain.
', 'DescribeDomainResponse$DomainArn' => 'The domain\'s Amazon Resource Name (ARN).
', 'DomainDetails$DomainArn' => 'The domain\'s Amazon Resource Name (ARN).
', 'UpdateDomainResponse$DomainArn' => 'The Amazon Resource Name (ARN) of the domain.
', ], ], 'DomainDetails' => [ 'base' => 'The domain\'s details.
', 'refs' => [ 'DomainList$member' => NULL, ], ], 'DomainId' => [ 'base' => NULL, 'refs' => [ 'AppDetails$DomainId' => 'The domain ID.
', 'CreateAppRequest$DomainId' => 'The domain ID.
', 'CreatePresignedDomainUrlRequest$DomainId' => 'The domain ID.
', 'CreateSpaceRequest$DomainId' => 'The ID of the associated Domain.
', 'CreateUserProfileRequest$DomainId' => 'The ID of the associated Domain.
', 'DeleteAppRequest$DomainId' => 'The domain ID.
', 'DeleteDomainRequest$DomainId' => 'The domain ID.
', 'DeleteSpaceRequest$DomainId' => 'The ID of the associated Domain.
', 'DeleteUserProfileRequest$DomainId' => 'The domain ID.
', 'DescribeAppRequest$DomainId' => 'The domain ID.
', 'DescribeAppResponse$DomainId' => 'The domain ID.
', 'DescribeDomainRequest$DomainId' => 'The domain ID.
', 'DescribeDomainResponse$DomainId' => 'The domain ID.
', 'DescribeSpaceRequest$DomainId' => 'The ID of the associated Domain.
', 'DescribeSpaceResponse$DomainId' => 'The ID of the associated Domain.
', 'DescribeUserProfileRequest$DomainId' => 'The domain ID.
', 'DescribeUserProfileResponse$DomainId' => 'The ID of the domain that contains the profile.
', 'DomainDetails$DomainId' => 'The domain ID.
', 'ListAppsRequest$DomainIdEquals' => 'A parameter to search for the domain ID.
', 'ListSpacesRequest$DomainIdEquals' => 'A parameter to search for the Domain ID.
', 'ListUserProfilesRequest$DomainIdEquals' => 'A parameter by which to filter the results.
', 'SpaceDetails$DomainId' => 'The ID of the associated Domain.
', 'UpdateDomainRequest$DomainId' => 'The ID of the domain to be updated.
', 'UpdateSpaceRequest$DomainId' => 'The ID of the associated Domain.
', 'UpdateUserProfileRequest$DomainId' => 'The domain ID.
', 'UserProfileDetails$DomainId' => 'The domain ID.
', ], ], 'DomainList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsResponse$Domains' => 'The list of domains.
', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$DomainName' => 'A name for the domain.
', 'DescribeDomainResponse$DomainName' => 'The domain name.
', 'DomainDetails$DomainName' => 'The domain name.
', ], ], 'DomainSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$SecurityGroupIds' => 'The security groups for the Amazon Virtual Private Cloud that the Domain uses for 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 apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.
A collection of Domain settings.
A collection of Domain settings.
A collection of Domain configuration settings to update.
A collection of DomainSettings configuration values to update.
The status.
', 'DomainDetails$Status' => 'The status.
', ], ], 'DoubleParameterValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameterValue$NumberValue' => 'The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can\'t specify the StringValue parameter.
Represents the drift check baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'CreateModelPackageInput$DriftCheckBaselines' => '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.
', 'DescribeModelPackageOutput$DriftCheckBaselines' => '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.
', 'ModelPackage$DriftCheckBaselines' => 'Represents the drift check baselines that can be used when the model monitor is set using the model package.
', ], ], 'DriftCheckBias' => [ 'base' => 'Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'DriftCheckBaselines$Bias' => 'Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
', ], ], 'DriftCheckExplainability' => [ 'base' => 'Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'DriftCheckBaselines$Explainability' => 'Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
', ], ], 'DriftCheckModelDataQuality' => [ 'base' => 'Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'DriftCheckBaselines$ModelDataQuality' => 'Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.
', ], ], 'DriftCheckModelQuality' => [ 'base' => 'Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'DriftCheckBaselines$ModelQuality' => 'Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
', ], ], 'EMRStepMetadata' => [ 'base' => 'The configurations and outcomes of an Amazon EMR step execution.
', 'refs' => [ 'PipelineExecutionStepMetadata$EMR' => 'The configurations and outcomes of an Amazon EMR step execution.
', ], ], 'Edge' => [ 'base' => 'A directed edge connecting two lineage entities.
', 'refs' => [ 'Edges$member' => NULL, ], ], 'EdgeDeploymentConfig' => [ 'base' => 'Contains information about the configuration of a deployment.
', 'refs' => [ 'DeploymentStage$DeploymentConfig' => 'Configuration of the deployment details.
', 'DeploymentStageStatusSummary$DeploymentConfig' => 'Configuration of the deployment details.
', ], ], 'EdgeDeploymentModelConfig' => [ 'base' => 'Contains information about the configuration of a model in a deployment.
', 'refs' => [ 'EdgeDeploymentModelConfigs$member' => NULL, ], ], 'EdgeDeploymentModelConfigs' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$ModelConfigs' => 'List of models associated with the edge deployment plan.
', 'DescribeEdgeDeploymentPlanResponse$ModelConfigs' => 'List of models associated with the edge deployment plan.
', ], ], 'EdgeDeploymentPlanArn' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => 'The ARN of the edge deployment plan.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => 'The ARN of edge deployment plan.
', 'DeviceDeploymentSummary$EdgeDeploymentPlanArn' => 'The ARN of the edge deployment plan.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanArn' => 'The ARN of the edge deployment plan.
', ], ], 'EdgeDeploymentPlanSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansResponse$EdgeDeploymentPlanSummaries' => 'List of summaries of edge deployment plans.
', ], ], 'EdgeDeploymentPlanSummary' => [ 'base' => 'Contains information summarizing an edge deployment plan.
', 'refs' => [ 'EdgeDeploymentPlanSummaries$member' => NULL, ], ], 'EdgeDeploymentStatus' => [ 'base' => 'Contains information summarizing the deployment stage results.
', 'refs' => [ 'DeploymentStageStatusSummary$DeploymentStatus' => 'General status of the current state.
', ], ], 'EdgeModel' => [ 'base' => 'The model on the edge device.
', 'refs' => [ 'EdgeModels$member' => NULL, ], ], 'EdgeModelStat' => [ 'base' => 'Status of edge devices with this model.
', 'refs' => [ 'EdgeModelStats$member' => NULL, ], ], 'EdgeModelStats' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$ModelStats' => 'Status of model on device.
', ], ], 'EdgeModelSummaries' => [ 'base' => NULL, 'refs' => [ 'DeviceSummary$Models' => 'Models on the device.
', ], ], 'EdgeModelSummary' => [ 'base' => 'Summary of model on edge device.
', 'refs' => [ 'EdgeModelSummaries$member' => NULL, ], ], 'EdgeModels' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Models' => 'Models on the device.
', ], ], 'EdgeOutputConfig' => [ 'base' => 'The output configuration.
', 'refs' => [ 'CreateDeviceFleetRequest$OutputConfig' => 'The output configuration for storing sample data collected by the fleet.
', 'CreateEdgePackagingJobRequest$OutputConfig' => 'Provides information about the output location for the packaged model.
', 'DescribeDeviceFleetResponse$OutputConfig' => 'The output configuration for storing sampled data.
', 'DescribeEdgePackagingJobResponse$OutputConfig' => 'The output configuration for the edge packaging job.
', 'GetDeviceFleetReportResponse$OutputConfig' => 'The output configuration for storing sample data collected by the fleet.
', 'UpdateDeviceFleetRequest$OutputConfig' => 'Output configuration for storing sample data collected by the fleet.
', ], ], 'EdgePackagingJobArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobArn' => 'The Amazon Resource Name (ARN) of the edge packaging job.
', 'EdgePackagingJobSummary$EdgePackagingJobArn' => 'The Amazon Resource Name (ARN) of the edge packaging job.
', ], ], 'EdgePackagingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatus' => 'The current status of the packaging job.
', 'EdgePackagingJobSummary$EdgePackagingJobStatus' => 'The status of the edge packaging job.
', 'ListEdgePackagingJobsRequest$StatusEquals' => 'The job status to filter for.
', ], ], 'EdgePackagingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsResponse$EdgePackagingJobSummaries' => 'Summaries of edge packaging jobs.
', ], ], 'EdgePackagingJobSummary' => [ 'base' => 'Summary of edge packaging job.
', 'refs' => [ 'EdgePackagingJobSummaries$member' => NULL, ], ], 'EdgePresetDeploymentArtifact' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Artifact' => 'The Amazon Resource Name (ARN) of the generated deployable resource.
', ], ], 'EdgePresetDeploymentOutput' => [ 'base' => 'The output of a SageMaker Edge Manager deployable resource.
', 'refs' => [ 'DescribeEdgePackagingJobResponse$PresetDeploymentOutput' => 'The output of a SageMaker Edge Manager deployable resource.
', ], ], 'EdgePresetDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Status' => 'The status of the deployable resource.
', ], ], 'EdgePresetDeploymentType' => [ 'base' => NULL, 'refs' => [ 'EdgeOutputConfig$PresetDeploymentType' => 'The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
', 'EdgePresetDeploymentOutput$Type' => 'The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
', ], ], 'EdgeVersion' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$Version' => 'Version of the agent.
', 'CreateEdgePackagingJobRequest$ModelVersion' => 'The version of the model.
', 'DescribeDeviceResponse$AgentVersion' => 'Edge Manager agent version.
', 'DescribeEdgePackagingJobResponse$ModelVersion' => 'The version of the model.
', 'DeviceSummary$AgentVersion' => 'Edge Manager agent version.
', 'EdgeModel$ModelVersion' => 'The model version.
', 'EdgeModelStat$ModelVersion' => 'The model version.
', 'EdgeModelSummary$ModelVersion' => 'The version model.
', 'EdgePackagingJobSummary$ModelVersion' => 'The version of the model.
', ], ], 'Edges' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Edges' => 'A list of edges that connect vertices in the response.
', ], ], 'EfsUid' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$HomeEfsFileSystemUid' => 'The ID of the space\'s profile in the Amazon Elastic File System volume.
', 'DescribeUserProfileResponse$HomeEfsFileSystemUid' => 'The ID of the user\'s profile in the Amazon Elastic File System (EFS) volume.
', ], ], 'EnableCapture' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$EnableCapture' => 'Whether data capture should be enabled or disabled (defaults to enabled).
', 'DataCaptureConfigSummary$EnableCapture' => 'Whether data capture is enabled or disabled.
', ], ], 'EnableIotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$EnableIotRoleAlias' => '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".
', 'UpdateDeviceFleetRequest$EnableIotRoleAlias' => '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".
', ], ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'Endpoint' => [ 'base' => 'A hosted endpoint for real-time inference.
', 'refs' => [ 'SearchRecord$Endpoint' => NULL, ], ], 'EndpointArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointOutput$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'DescribeEndpointOutput$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'Endpoint$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'EndpointSummary$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'ModelDashboardEndpoint$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'UpdateEndpointOutput$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'UpdateEndpointWeightsAndCapacitiesOutput$EndpointArn' => 'The Amazon Resource Name (ARN) of the updated endpoint.
', ], ], 'EndpointConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigOutput$EndpointConfigArn' => 'The Amazon Resource Name (ARN) of the endpoint configuration.
', 'DescribeEndpointConfigOutput$EndpointConfigArn' => 'The Amazon Resource Name (ARN) of the endpoint configuration.
', 'EndpointConfigSummary$EndpointConfigArn' => 'The Amazon Resource Name (ARN) of the endpoint configuration.
', ], ], 'EndpointConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$EndpointConfigName' => 'The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
', 'CreateEndpointInput$EndpointConfigName' => 'The name of an endpoint configuration. For more information, see CreateEndpointConfig.
', 'DeleteEndpointConfigInput$EndpointConfigName' => 'The name of the endpoint configuration that you want to delete.
', 'DescribeEndpointConfigInput$EndpointConfigName' => 'The name of the endpoint configuration.
', 'DescribeEndpointConfigOutput$EndpointConfigName' => 'Name of the SageMaker endpoint configuration.
', 'DescribeEndpointOutput$EndpointConfigName' => 'The name of the endpoint configuration associated with this endpoint.
', 'Endpoint$EndpointConfigName' => 'The endpoint configuration associated with the endpoint.
', 'EndpointConfigSummary$EndpointConfigName' => 'The name of the endpoint configuration.
', 'EndpointMetadata$EndpointConfigName' => 'The name of the endpoint configuration.
', 'PendingDeploymentSummary$EndpointConfigName' => 'The name of the endpoint configuration used in the deployment.
', 'UpdateEndpointInput$EndpointConfigName' => 'The name of the new endpoint configuration.
', ], ], 'EndpointConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NameContains' => 'A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.
', ], ], 'EndpointConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortBy' => 'The field to sort results by. The default is CreationTime.
Provides summary information for an endpoint configuration.
', 'refs' => [ 'EndpointConfigSummaryList$member' => NULL, ], ], 'EndpointConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsOutput$EndpointConfigs' => 'An array of endpoint configurations.
', ], ], 'EndpointInfo' => [ 'base' => 'Details about a customer endpoint that was compared in an Inference Recommender job.
', 'refs' => [ 'EndpointPerformance$EndpointInfo' => NULL, 'Endpoints$member' => NULL, ], ], 'EndpointInput' => [ 'base' => 'Input object for the endpoint
', 'refs' => [ 'DataQualityJobInput$EndpointInput' => NULL, 'ModelBiasJobInput$EndpointInput' => NULL, 'ModelExplainabilityJobInput$EndpointInput' => NULL, 'ModelQualityJobInput$EndpointInput' => NULL, 'MonitoringInput$EndpointInput' => 'The endpoint for a monitoring job.
', ], ], 'EndpointInputConfiguration' => [ 'base' => 'The endpoint configuration for the load test.
', 'refs' => [ 'EndpointInputConfigurations$member' => NULL, ], ], 'EndpointInputConfigurations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$EndpointConfigurations' => 'Specifies the endpoint configuration to use for a job.
', ], ], 'EndpointMetadata' => [ 'base' => 'The metadata of the endpoint.
', 'refs' => [ 'DescribeInferenceExperimentResponse$EndpointMetadata' => 'The metadata of the endpoint on which the inference experiment ran.
', ], ], 'EndpointName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointInput$EndpointName' => '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.
The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.
', 'DeleteEndpointInput$EndpointName' => 'The name of the endpoint that you want to delete.
', 'DescribeEndpointInput$EndpointName' => 'The name of the endpoint.
', 'DescribeEndpointOutput$EndpointName' => 'Name of the endpoint.
', 'DescribeMonitoringScheduleResponse$EndpointName' => 'The name of the endpoint for the monitoring job.
', 'Endpoint$EndpointName' => 'The name of the endpoint.
', 'EndpointInfo$EndpointName' => 'The name of a customer\'s endpoint.
', 'EndpointInput$EndpointName' => 'An endpoint in customer\'s account which has enabled DataCaptureConfig enabled.
The name of the endpoint.
', 'EndpointSummary$EndpointName' => 'The name of the endpoint.
', 'ListDataQualityJobDefinitionsRequest$EndpointName' => 'A filter that lists the data quality job definitions associated with the specified endpoint.
', 'ListModelBiasJobDefinitionsRequest$EndpointName' => 'Name of the endpoint to monitor for model bias.
', 'ListModelExplainabilityJobDefinitionsRequest$EndpointName' => 'Name of the endpoint to monitor for model explainability.
', 'ListModelQualityJobDefinitionsRequest$EndpointName' => 'A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.
', 'ListMonitoringExecutionsRequest$EndpointName' => 'Name of a specific endpoint to fetch jobs for.
', 'ListMonitoringSchedulesRequest$EndpointName' => 'Name of a specific endpoint to fetch schedules for.
', 'ModelDashboardEndpoint$EndpointName' => 'The endpoint name.
', 'ModelDashboardMonitoringSchedule$EndpointName' => 'The endpoint which is monitored.
', 'ModelDeployConfig$EndpointName' => '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.
The name of the endpoint to which the model has been deployed.
If model deployment fails, this field is omitted from the response.
The name of the endpoint used to run the monitoring job.
', 'MonitoringJobDefinitionSummary$EndpointName' => 'The name of the endpoint that the job monitors.
', 'MonitoringSchedule$EndpointName' => 'The endpoint that hosts the model being monitored.
', 'MonitoringScheduleSummary$EndpointName' => 'The name of the endpoint using the monitoring schedule.
', 'UpdateEndpointInput$EndpointName' => 'The name of the endpoint whose configuration you want to update.
', 'UpdateEndpointWeightsAndCapacitiesInput$EndpointName' => 'The name of an existing SageMaker endpoint.
', ], ], 'EndpointNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$NameContains' => 'A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
', ], ], 'EndpointOutputConfiguration' => [ 'base' => 'The endpoint configuration made by Inference Recommender during a recommendation job.
', 'refs' => [ 'InferenceRecommendation$EndpointConfiguration' => 'Defines the endpoint configuration parameters.
', 'RecommendationJobInferenceBenchmark$EndpointConfiguration' => NULL, ], ], 'EndpointPerformance' => [ 'base' => 'The performance results from running an Inference Recommender job on an existing endpoint.
', 'refs' => [ 'EndpointPerformances$member' => NULL, ], ], 'EndpointPerformances' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$EndpointPerformances' => 'The performance results from running an Inference Recommender job on an existing endpoint.
', ], ], 'EndpointSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$SortBy' => 'Sorts the list of results. The default is CreationTime.
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.
The status of the endpoint.
', 'EndpointMetadata$EndpointStatus' => 'The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.
', 'EndpointSummary$EndpointStatus' => '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.
A filter that returns only endpoints with the specified status.
', 'ModelDashboardEndpoint$EndpointStatus' => 'The endpoint status.
', ], ], 'EndpointSummary' => [ 'base' => 'Provides summary information for an endpoint.
', 'refs' => [ 'EndpointSummaryList$member' => NULL, ], ], 'EndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsOutput$Endpoints' => 'An array or endpoint objects.
', ], ], 'Endpoints' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$Endpoints' => 'Existing customer endpoints on which to run an Inference Recommender job.
', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Description' => 'A description of the additional Inference specification
', 'AlgorithmSummary$AlgorithmDescription' => 'A brief description of the algorithm.
', 'BatchDescribeModelPackageSummary$ModelPackageDescription' => 'The description of the model package.
', 'ChannelSpecification$Description' => 'A brief description of the channel.
', 'CreateAlgorithmInput$AlgorithmDescription' => 'A description of the algorithm.
', 'CreateModelPackageGroupInput$ModelPackageGroupDescription' => 'A description for the model group.
', 'CreateModelPackageInput$ModelPackageDescription' => 'A description of the model package.
', 'CreateProjectInput$ProjectDescription' => 'A description for the project.
', 'DescribeAlgorithmOutput$AlgorithmDescription' => 'A brief summary about the algorithm.
', 'DescribeModelPackageGroupOutput$ModelPackageGroupDescription' => 'A description of the model group.
', 'DescribeModelPackageOutput$ModelPackageDescription' => 'A brief summary of the model package.
', 'DescribeProjectOutput$ProjectDescription' => 'The description of the project.
', 'HyperParameterSpecification$Description' => 'A brief description of the hyperparameter.
', 'ModelPackage$ModelPackageDescription' => 'The description of the model package.
', 'ModelPackageGroup$ModelPackageGroupDescription' => 'The description for the model group.
', 'ModelPackageGroupSummary$ModelPackageGroupDescription' => 'A description of the model group.
', 'ModelPackageSummary$ModelPackageDescription' => 'A brief description of the model package.
', 'Project$ProjectDescription' => 'The description of the project.
', 'ProjectSummary$ProjectDescription' => 'The description of the project.
', 'UpdateProjectInput$ProjectDescription' => 'The description for the project.
', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Name' => '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.
', 'AlgorithmStatusItem$Name' => 'The name of the algorithm for which the overall status is being reported.
', 'AlgorithmSummary$AlgorithmName' => 'The name of the algorithm that is described by the summary.
', 'AlgorithmValidationProfile$ProfileName' => '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).
', 'BatchDescribeModelPackageSummary$ModelPackageGroupName' => 'The group name for the model package
', 'CodeRepositorySummary$CodeRepositoryName' => 'The name of the Git repository.
', 'CompilationJobSummary$CompilationJobName' => 'The name of the model compilation job that you want a summary for.
', 'CreateAlgorithmInput$AlgorithmName' => 'The name of the algorithm.
', 'CreateCodeRepositoryInput$CodeRepositoryName' => '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).
', 'CreateCompilationJobRequest$CompilationJobName' => 'A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
', 'CreateDeviceFleetRequest$DeviceFleetName' => 'The name of the fleet that the device belongs to.
', 'CreateEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'CreateEdgeDeploymentPlanRequest$DeviceFleetName' => 'The device fleet used for this edge deployment plan.
', 'CreateEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'CreateEdgePackagingJobRequest$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'CreateEdgePackagingJobRequest$CompilationJobName' => 'The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
', 'CreateEdgePackagingJobRequest$ModelName' => 'The name of the model.
', 'CreateModelCardExportJobRequest$ModelCardName' => 'The name of the model card to export.
', 'CreateModelCardExportJobRequest$ModelCardExportJobName' => 'The name of the model card export job.
', 'CreateModelCardRequest$ModelCardName' => 'The unique name of the model card.
', 'CreateModelPackageGroupInput$ModelPackageGroupName' => 'The name of the model group.
', 'CreateModelPackageInput$ModelPackageName' => '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.
', 'DeleteAlgorithmInput$AlgorithmName' => 'The name of the algorithm to delete.
', 'DeleteCodeRepositoryInput$CodeRepositoryName' => 'The name of the Git repository to delete.
', 'DeleteDeviceFleetRequest$DeviceFleetName' => 'The name of the fleet to delete.
', 'DeleteEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan to delete.
', 'DeleteEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan from which the stage will be deleted.
', 'DeleteEdgeDeploymentStageRequest$StageName' => 'The name of the stage.
', 'DeleteModelCardRequest$ModelCardName' => 'The name of the model card to delete.
', 'DeleteModelPackageGroupPolicyInput$ModelPackageGroupName' => 'The name of the model group for which to delete the policy.
', 'DeploymentStage$StageName' => 'The name of the stage.
', 'DeploymentStageStatusSummary$StageName' => 'The name of the stage.
', 'DeregisterDevicesRequest$DeviceFleetName' => 'The name of the fleet the devices belong to.
', 'DescribeAlgorithmOutput$AlgorithmName' => 'The name of the algorithm being described.
', 'DescribeCodeRepositoryInput$CodeRepositoryName' => 'The name of the Git repository to describe.
', 'DescribeCodeRepositoryOutput$CodeRepositoryName' => 'The name of the Git repository.
', 'DescribeCompilationJobRequest$CompilationJobName' => 'The name of the model compilation job that you want information about.
', 'DescribeCompilationJobResponse$CompilationJobName' => 'The name of the model compilation job.
', 'DescribeDeviceFleetRequest$DeviceFleetName' => 'The name of the fleet.
', 'DescribeDeviceFleetResponse$DeviceFleetName' => 'The name of the fleet.
', 'DescribeDeviceRequest$DeviceName' => 'The unique ID of the device.
', 'DescribeDeviceRequest$DeviceFleetName' => 'The name of the fleet the devices belong to.
', 'DescribeDeviceResponse$DeviceName' => 'The unique identifier of the device.
', 'DescribeDeviceResponse$DeviceFleetName' => 'The name of the fleet the device belongs to.
', 'DescribeEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => 'The name of the deployment plan to describe.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'DescribeEdgeDeploymentPlanResponse$DeviceFleetName' => 'The device fleet used for this edge deployment plan.
', 'DescribeEdgePackagingJobRequest$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'DescribeEdgePackagingJobResponse$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'DescribeEdgePackagingJobResponse$CompilationJobName' => 'The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.
', 'DescribeEdgePackagingJobResponse$ModelName' => 'The name of the model.
', 'DescribeModelCardExportJobResponse$ModelCardExportJobName' => 'The name of the model card export job to describe.
', 'DescribeModelCardExportJobResponse$ModelCardName' => 'The name of the model card that the model export job exports.
', 'DescribeModelCardRequest$ModelCardName' => 'The name of the model card to describe.
', 'DescribeModelCardResponse$ModelCardName' => 'The name of the model card.
', 'DescribeModelPackageGroupOutput$ModelPackageGroupName' => 'The name of the model group.
', 'DescribeModelPackageOutput$ModelPackageName' => 'The name of the model package being described.
', 'DescribeModelPackageOutput$ModelPackageGroupName' => 'If the model is a versioned model, the name of the model group that the versioned model belongs to.
', 'DeviceDeploymentSummary$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'DeviceDeploymentSummary$StageName' => 'The name of the stage in the edge deployment plan.
', 'DeviceDeploymentSummary$DeployedStageName' => 'The name of the deployed stage.
', 'DeviceDeploymentSummary$DeviceFleetName' => 'The name of the fleet to which the device belongs to.
', 'DeviceFleetSummary$DeviceFleetName' => 'Name of the device fleet.
', 'DeviceSummary$DeviceName' => 'The unique identifier of the device.
', 'DeviceSummary$DeviceFleetName' => 'The name of the fleet the device belongs to.
', 'EdgeDeploymentModelConfig$ModelHandle' => 'The name the device application uses to reference this model.
', 'EdgeDeploymentModelConfig$EdgePackagingJobName' => 'The edge packaging job associated with this deployment.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'EdgeDeploymentPlanSummary$DeviceFleetName' => 'The name of the device fleet used for the deployment.
', 'EdgeModel$ModelName' => 'The name of the model.
', 'EdgeModelStat$ModelName' => 'The name of the model.
', 'EdgeModelSummary$ModelName' => 'The name of the model.
', 'EdgePackagingJobSummary$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'EdgePackagingJobSummary$CompilationJobName' => 'The name of the SageMaker Neo compilation job.
', 'EdgePackagingJobSummary$ModelName' => 'The name of the model.
', 'GetDeviceFleetReportRequest$DeviceFleetName' => 'The name of the fleet.
', 'GetDeviceFleetReportResponse$DeviceFleetName' => 'The name of the fleet.
', 'GetModelPackageGroupPolicyInput$ModelPackageGroupName' => 'The name of the model group for which to get the resource policy.
', 'ListDevicesRequest$ModelName' => 'A filter that searches devices that contains this name in any of their models.
', 'ListDevicesRequest$DeviceFleetName' => 'Filter for fleets containing this name in their device fleet name.
', 'ListModelCardExportJobsRequest$ModelCardName' => 'List export jobs for the model card with the specified name.
', 'ListModelCardExportJobsRequest$ModelCardExportJobNameContains' => 'Only list model card export jobs with names that contain the specified string.
', 'ListModelCardVersionsRequest$ModelCardName' => 'List model card versions for the model card with the specified name.
', 'ListModelCardsRequest$NameContains' => 'Only list model cards with names that contain the specified string.
', 'ListStageDevicesRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'ListStageDevicesRequest$StageName' => 'The name of the stage in the deployment.
', 'ModelCard$ModelCardName' => 'The unique name of the model card.
', 'ModelCardExportJobSummary$ModelCardExportJobName' => 'The name of the model card export job.
', 'ModelCardExportJobSummary$ModelCardName' => 'The name of the model card that the export job exports.
', 'ModelCardSummary$ModelCardName' => 'The name of the model card.
', 'ModelCardVersionSummary$ModelCardName' => 'The name of the model card.
', 'ModelDashboardModelCard$ModelCardName' => 'The name of a model card.
', 'ModelPackage$ModelPackageName' => 'The name of the model.
', 'ModelPackage$ModelPackageGroupName' => 'The model group to which the model belongs.
', 'ModelPackageGroup$ModelPackageGroupName' => 'The name of the model group.
', 'ModelPackageGroupSummary$ModelPackageGroupName' => 'The name of the model group.
', 'ModelPackageStatusItem$Name' => 'The name of the model package for which the overall status is being reported.
', 'ModelPackageSummary$ModelPackageName' => 'The name of the model package.
', 'ModelPackageSummary$ModelPackageGroupName' => 'If the model package is a versioned model, the model group that the versioned model belongs to.
', 'ModelPackageValidationProfile$ProfileName' => 'The name of the profile for the model package.
', 'PutModelPackageGroupPolicyInput$ModelPackageGroupName' => 'The name of the model group to add a resource policy to.
', 'RegisterDevicesRequest$DeviceFleetName' => 'The name of the fleet.
', 'StartEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan to start.
', 'StartEdgeDeploymentStageRequest$StageName' => 'The name of the stage to start.
', 'StopCompilationJobRequest$CompilationJobName' => 'The name of the model compilation job to stop.
', 'StopEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan to stop.
', 'StopEdgeDeploymentStageRequest$StageName' => 'The name of the stage to stop.
', 'StopEdgePackagingJobRequest$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'UpdateCodeRepositoryInput$CodeRepositoryName' => 'The name of the Git repository to update.
', 'UpdateDeviceFleetRequest$DeviceFleetName' => 'The name of the fleet.
', 'UpdateDevicesRequest$DeviceFleetName' => 'The name of the fleet the devices belong to.
', 'UpdateModelCardRequest$ModelCardName' => 'The name of the model card to update.
', ], ], 'EnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$key' => NULL, ], ], 'EnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Environment' => 'The environment variables to set in the container. For more information, see ContainerDefinition.
', 'ContainerDefinition$Environment' => '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 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 recommended environment variables to set in the model container for Real-Time Inference.
', ], ], 'EnvironmentParameter' => [ 'base' => 'A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.
', 'refs' => [ 'EnvironmentParameters$member' => NULL, ], ], 'EnvironmentParameterRanges' => [ 'base' => 'Specifies the range of environment parameters
', 'refs' => [ 'EndpointInputConfiguration$EnvironmentParameterRanges' => 'The parameter you want to benchmark against.
', ], ], 'EnvironmentParameters' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$EnvironmentParameters' => 'Defines the environment parameters that includes key, value types, and values.
', ], ], 'EnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$value' => NULL, ], ], 'ExecutionRoleIdentityConfig' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$ExecutionRoleIdentityConfig' => 'The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
', 'DomainSettingsForUpdate$ExecutionRoleIdentityConfig' => 'The configuration for attaching a SageMaker 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.
A filter that retrieves only jobs with a specific status.
', 'MonitoringExecutionSummary$MonitoringExecutionStatus' => 'The status of the monitoring job.
', ], ], 'ExitMessage' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ExitMessage' => 'An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
', 'ProcessingJob$ExitMessage' => 'A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
', 'ProcessingJobSummary$ExitMessage' => 'An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
', ], ], 'Experiment' => [ 'base' => 'The properties of an experiment as returned by the Search API.
', 'refs' => [ 'SearchRecord$Experiment' => 'The properties of an experiment.
', ], ], 'ExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateExperimentResponse$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', 'DeleteExperimentResponse$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment that is being deleted.
', 'DescribeExperimentResponse$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', 'Experiment$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', 'ExperimentSummary$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', 'UpdateExperimentResponse$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', ], ], 'ExperimentConfig' => [ 'base' => 'Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
', 'refs' => [ 'CreateProcessingJobRequest$ExperimentConfig' => NULL, 'CreateTrainingJobRequest$ExperimentConfig' => NULL, 'CreateTransformJobRequest$ExperimentConfig' => NULL, 'DescribeProcessingJobResponse$ExperimentConfig' => 'The configuration information used to create an experiment.
', 'DescribeTrainingJobResponse$ExperimentConfig' => NULL, 'DescribeTransformJobResponse$ExperimentConfig' => NULL, 'ProcessingJob$ExperimentConfig' => NULL, 'TrainingJob$ExperimentConfig' => NULL, 'TransformJob$ExperimentConfig' => NULL, ], ], 'ExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Description' => 'The description of the action.
', 'CreateContextRequest$Description' => 'The description of the context.
', 'CreateExperimentRequest$Description' => 'The description of the experiment.
', 'DescribeActionResponse$Description' => 'The description of the action.
', 'DescribeContextResponse$Description' => 'The description of the context.
', 'DescribeExperimentResponse$Description' => 'The description of the experiment.
', 'DescribeLineageGroupResponse$Description' => 'The description of the lineage group.
', 'Experiment$Description' => 'The description of the experiment.
', 'UpdateActionRequest$Description' => 'The new description for the action.
', 'UpdateContextRequest$Description' => 'The new description for the context.
', 'UpdateExperimentRequest$Description' => 'The description of the experiment.
', ], ], 'ExperimentEntityName' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionName' => 'The name of the action.
', 'ArtifactSummary$ArtifactName' => 'The name of the artifact.
', 'AssociateTrialComponentRequest$TrialComponentName' => 'The name of the component to associated with the trial.
', 'AssociateTrialComponentRequest$TrialName' => 'The name of the trial to associate with.
', 'AssociationSummary$SourceName' => 'The name of the source.
', 'AssociationSummary$DestinationName' => 'The name of the destination.
', 'ContextSummary$ContextName' => 'The name of the context.
', 'CreateActionRequest$ActionName' => 'The name of the action. Must be unique to your account in an Amazon Web Services Region.
', 'CreateArtifactRequest$ArtifactName' => 'The name of the artifact. Must be unique to your account in an Amazon Web Services Region.
', 'CreateContextRequest$ContextName' => 'The name of the context. Must be unique to your account in an Amazon Web Services Region.
', 'CreateExperimentRequest$ExperimentName' => 'The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.
', 'CreateExperimentRequest$DisplayName' => '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.
The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
', 'CreateTrialComponentRequest$DisplayName' => '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. The name must be unique in your Amazon Web Services account and is not case-sensitive.
', 'CreateTrialRequest$DisplayName' => 'The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.
The name of the experiment to associate the trial with.
', 'DeleteActionRequest$ActionName' => 'The name of the action to delete.
', 'DeleteContextRequest$ContextName' => 'The name of the context to delete.
', 'DeleteExperimentRequest$ExperimentName' => 'The name of the experiment to delete.
', 'DeleteTrialComponentRequest$TrialComponentName' => 'The name of the component to delete.
', 'DeleteTrialRequest$TrialName' => 'The name of the trial to delete.
', 'DescribeActionRequest$ActionName' => 'The name of the action to describe.
', 'DescribeContextResponse$ContextName' => 'The name of the context.
', 'DescribeExperimentRequest$ExperimentName' => 'The name of the experiment to describe.
', 'DescribeExperimentResponse$ExperimentName' => 'The name of the experiment.
', 'DescribeExperimentResponse$DisplayName' => 'The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.
The name of the lineage group.
', 'DescribeLineageGroupResponse$LineageGroupName' => 'The name of the lineage group.
', 'DescribeLineageGroupResponse$DisplayName' => 'The display name of the lineage group.
', 'DescribeTrialComponentResponse$TrialComponentName' => 'The name of the trial component.
', 'DescribeTrialComponentResponse$DisplayName' => 'The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.
The name of the trial to describe.
', 'DescribeTrialResponse$TrialName' => 'The name of the trial.
', 'DescribeTrialResponse$DisplayName' => 'The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.
The name of the experiment the trial is part of.
', 'DisassociateTrialComponentRequest$TrialComponentName' => 'The name of the component to disassociate from the trial.
', 'DisassociateTrialComponentRequest$TrialName' => 'The name of the trial to disassociate from.
', 'Experiment$ExperimentName' => 'The name of the experiment.
', 'Experiment$DisplayName' => 'The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.
The name of an existing experiment to associate with the trial component.
', 'ExperimentConfig$TrialName' => 'The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
', 'ExperimentConfig$TrialComponentDisplayName' => 'The display name for the trial component. If this key isn\'t specified, the display name is the trial component name.
', 'ExperimentConfig$RunName' => 'The name of the experiment run to associate with the trial component.
', 'ExperimentSummary$ExperimentName' => 'The name of the experiment.
', 'ExperimentSummary$DisplayName' => 'The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.
The name or Amazon Resource Name (ARN) of the lineage group.
', 'LineageGroupSummary$DisplayName' => 'The display name of the lineage group summary.
', 'ListTrialComponentsRequest$ExperimentName' => '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 TrialName, you can\'t filter by ExperimentName or SourceArn.
A filter that returns only trials that are part of the specified experiment.
', 'ListTrialsRequest$TrialComponentName' => 'A filter that returns only trials that are associated with the specified trial component.
', 'Parent$TrialName' => 'The name of the trial.
', 'Parent$ExperimentName' => 'The name of the experiment.
', 'PipelineExperimentConfig$ExperimentName' => 'The name of the experiment.
', 'PipelineExperimentConfig$TrialName' => 'The name of the trial.
', 'Trial$TrialName' => 'The name of the trial.
', 'Trial$DisplayName' => 'The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.
The name of the experiment the trial is part of.
', 'TrialComponent$TrialComponentName' => 'The name of the trial component.
', 'TrialComponent$DisplayName' => 'The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.
The name of the experiment run.
', 'TrialComponentSimpleSummary$TrialComponentName' => 'The name of the trial component.
', 'TrialComponentSummary$TrialComponentName' => 'The name of the trial component.
', 'TrialComponentSummary$DisplayName' => 'The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.
The name of the trial.
', 'TrialSummary$DisplayName' => 'The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.
The name of the action to update.
', 'UpdateArtifactRequest$ArtifactName' => 'The new name for the artifact.
', 'UpdateContextRequest$ContextName' => 'The name of the context to update.
', 'UpdateExperimentRequest$ExperimentName' => 'The name of the experiment to update.
', 'UpdateExperimentRequest$DisplayName' => 'The name of the experiment as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, ExperimentName is displayed.
The name of the component to update.
', 'UpdateTrialComponentRequest$DisplayName' => '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 to update.
', 'UpdateTrialRequest$DisplayName' => 'The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.
The name of the action.
', 'DescribeArtifactResponse$ArtifactName' => 'The name of the artifact.
', 'DescribeContextRequest$ContextName' => 'The name of the context to describe.
', 'DescribeTrialComponentRequest$TrialComponentName' => 'The name of the trial component to describe.
', ], ], 'ExperimentSource' => [ 'base' => 'The source of the experiment.
', 'refs' => [ 'DescribeExperimentResponse$Source' => 'The Amazon Resource Name (ARN) of the source and, optionally, the type.
', 'Experiment$Source' => NULL, 'ExperimentSummary$ExperimentSource' => NULL, ], ], 'ExperimentSourceArn' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceArn' => 'The Amazon Resource Name (ARN) of the source.
', ], ], 'ExperimentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsResponse$ExperimentSummaries' => 'A list of the summaries of your experiments.
', ], ], 'ExperimentSummary' => [ 'base' => 'A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.
The number of seconds until the pre-signed URL expires. This value defaults to 300.
', ], ], 'Explainability' => [ 'base' => 'Contains explainability metrics for a model.
', 'refs' => [ 'ModelMetrics$Explainability' => 'Metrics that help explain a model.
', ], ], 'ExplainabilityLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$Explainability' => 'The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.
', ], ], 'ExplainerConfig' => [ 'base' => 'A parameter to activate explainers.
', 'refs' => [ 'CreateEndpointConfigInput$ExplainerConfig' => 'A member of CreateEndpointConfig that enables explainers.
The configuration parameters for an explainer.
', 'DescribeEndpointOutput$ExplainerConfig' => 'The configuration parameters for an explainer.
', ], ], 'FailStepMetadata' => [ 'base' => 'The container for the metadata for Fail step.
', 'refs' => [ 'PipelineExecutionStepMetadata$Fail' => 'The configurations and outcomes of a Fail step execution.
', ], ], 'FailureHandlingPolicy' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentConfig$FailureHandlingPolicy' => '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.
', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Message' => NULL, 'DescribeAppResponse$FailureReason' => 'The failure reason.
', 'DescribeCompilationJobResponse$FailureReason' => 'If a model compilation job failed, the reason it failed.
', 'DescribeDomainResponse$FailureReason' => 'The failure reason.
', 'DescribeEndpointOutput$FailureReason' => 'If the status of the endpoint is Failed, the reason why it failed.
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.
The reason your flow definition failed.
', 'DescribeHubContentResponse$FailureReason' => 'The failure reason if importing hub content failed.
', 'DescribeHubResponse$FailureReason' => 'The failure reason if importing hub content failed.
', 'DescribeHyperParameterTuningJobResponse$FailureReason' => 'If the tuning job failed, the reason it failed.
', 'DescribeImageResponse$FailureReason' => 'When a create, update, or delete operation fails, the reason for the failure.
', 'DescribeImageVersionResponse$FailureReason' => 'When a create or delete operation fails, the reason for the failure.
', 'DescribeInferenceRecommendationsJobResponse$FailureReason' => 'If the job fails, provides information why the job failed.
', 'DescribeLabelingJobResponse$FailureReason' => 'If the job failed, the reason that it failed.
', 'DescribeModelCardExportJobResponse$FailureReason' => 'The failure reason if the model export job fails.
', 'DescribeMonitoringScheduleResponse$FailureReason' => 'A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.
', 'DescribeNotebookInstanceOutput$FailureReason' => 'If status is Failed, the reason it failed.
A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
', 'DescribeSpaceResponse$FailureReason' => 'The failure reason.
', 'DescribeTrainingJobResponse$FailureReason' => 'If the training job failed, the reason it failed.
', 'DescribeTransformJobResponse$FailureReason' => '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 failure reason.
', 'Endpoint$FailureReason' => 'If the endpoint failed, the reason it failed.
', 'EndpointMetadata$FailureReason' => ' 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 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.
The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
The reason that the training job failed.
', 'HyperParameterTuningJobSearchEntity$FailureReason' => 'The error that was created when a hyperparameter tuning job failed.
', 'Image$FailureReason' => 'When a create, update, or delete operation fails, the reason for the failure.
', 'ImageVersion$FailureReason' => 'When a create or delete operation fails, the reason for the failure.
', 'InferenceRecommendationsJob$FailureReason' => 'If the job fails, provides information why the job failed.
', 'LabelingJobSummary$FailureReason' => 'If the LabelingJobStatus field is Failed, this field contains a description of the error.
If the update wasn\'t successful, indicates the reason why it failed.
', 'ModelDashboardMonitoringSchedule$FailureReason' => 'If a monitoring job failed, provides the reason.
', 'MonitoringExecutionSummary$FailureReason' => 'Contains the reason a monitoring job failed, if it failed.
', 'MonitoringSchedule$FailureReason' => 'If the monitoring schedule failed, the reason it failed.
', 'PipelineExecutionStep$FailureReason' => 'The reason why the step failed execution. This is only returned if the step failed its execution.
', 'ProcessingJob$FailureReason' => 'A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
', 'ProcessingJobSummary$FailureReason' => 'A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
', 'ResourceInUse$Message' => NULL, 'ResourceLimitExceeded$Message' => NULL, 'ResourceNotFound$Message' => NULL, 'TrainingJob$FailureReason' => 'If the training job failed, the reason it failed.
', 'TransformJob$FailureReason' => 'If the transform job failed, the reason it failed.
', 'TransformJobSummary$FailureReason' => 'If the transform job failed, the reason it failed.
', ], ], 'FeatureAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureGroupRequest$FeatureAdditions' => '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.
', ], ], 'FeatureDefinition' => [ 'base' => 'A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.
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.
A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.
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 description you added to describe the feature.
', 'FeatureMetadata$Description' => 'An optional description that you specify to better describe the feature.
', 'UpdateFeatureMetadataRequest$Description' => 'A description that you can write to better describe the feature.
', ], ], 'FeatureGroup' => [ 'base' => '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.
', 'refs' => [ 'SearchRecord$FeatureGroup' => NULL, ], ], 'FeatureGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupResponse$FeatureGroupArn' => 'The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.
The Amazon Resource Name (ARN) of the FeatureGroup.
The Amazon Resource Number (ARN) of the feature group that contains the feature.
', 'FeatureGroup$FeatureGroupArn' => 'The Amazon Resource Name (ARN) of a FeatureGroup.
Unique identifier for the FeatureGroup.
The Amazon Resource Number (ARN) of the feature group.
', 'UpdateFeatureGroupResponse$FeatureGroupArn' => 'The Amazon Resource Number (ARN) of the feature group that you\'re updating.
', ], ], 'FeatureGroupMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$MaxResults' => 'The maximum number of results returned by ListFeatureGroups.
The 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 and end with an alphanumeric character.
Can only contain alphanumeric character and hyphens. Spaces are not allowed.
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.
he name of the FeatureGroup.
The name of the feature group that you\'ve specified.
', 'FeatureGroup$FeatureGroupName' => 'The name of the FeatureGroup.
The name of FeatureGroup.
The name of the feature group containing the feature.
', 'ProcessingFeatureStoreOutput$FeatureGroupName' => '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.
', ], ], 'FeatureGroupNameContains' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$NameContains' => 'A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.
The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.
The name or Amazon Resource Name (ARN) of the feature group containing the feature.
', 'UpdateFeatureGroupRequest$FeatureGroupName' => 'The name or Amazon Resource Name (ARN) of the feature group that you\'re updating.
', 'UpdateFeatureMetadataRequest$FeatureGroupName' => 'The name or Amazon Resource Name (ARN) of the feature group containing the feature that you\'re updating.
', ], ], 'FeatureGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortBy' => 'The value on which the feature group list is sorted.
', ], ], 'FeatureGroupSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortOrder' => 'The order in which feature groups are listed.
', ], ], 'FeatureGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$FeatureGroupStatus' => 'The status of the feature group.
', 'FeatureGroup$FeatureGroupStatus' => 'A FeatureGroup status.
The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.
A FeatureGroup status. Filters by FeatureGroup status.
A summary of feature groups.
', ], ], 'FeatureGroupSummary' => [ 'base' => '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 is updated automatically.
', 'refs' => [ 'SearchRecord$FeatureMetadata' => 'The feature metadata used to search through the features.
', ], ], 'FeatureName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$RecordIdentifierFeatureName' => 'The 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 and end 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 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.
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 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.
The name of the feature.
', 'DescribeFeatureMetadataResponse$FeatureName' => 'The name of the feature that you\'ve specified.
', 'FeatureDefinition$FeatureName' => 'The 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 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 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.
The name of feature.
', 'UpdateFeatureMetadataRequest$FeatureName' => 'The name of the feature that you\'re updating.
', ], ], 'FeatureParameter' => [ 'base' => 'A key-value pair that you specify to describe the feature.
', 'refs' => [ 'FeatureParameterAdditions$member' => NULL, 'FeatureParameters$member' => NULL, ], ], 'FeatureParameterAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterAdditions' => 'A list of key-value pairs that you can add to better describe the feature.
', ], ], 'FeatureParameterKey' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Key' => 'A key that must contain a value to describe the feature.
', 'FeatureParameterRemovals$member' => NULL, ], ], 'FeatureParameterRemovals' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterRemovals' => 'A list of parameter keys that you can specify to remove parameters that describe your feature.
', ], ], 'FeatureParameterValue' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Value' => 'The value that belongs to a key.
', ], ], 'FeatureParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Parameters' => 'The key-value pairs that you added to describe the feature.
', 'FeatureMetadata$Parameters' => 'Optional key-value pairs that you specify to better describe the feature.
', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'ModelRegisterSettings$Status' => 'Describes whether the integration to the model registry is enabled or disabled in the Canvas application.
', 'TimeSeriesForecastingSettings$Status' => 'Describes whether time series forecasting is enabled or disabled in the Canvas application.
', ], ], 'FeatureType' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$FeatureType' => 'The data type of the feature.
', 'FeatureDefinition$FeatureType' => 'The value type of a feature. Valid values are Integral, Fractional, or String.
', 'FeatureMetadata$FeatureType' => 'The data type of the feature.
', ], ], 'FileSource' => [ 'base' => 'Contains details regarding the file source.
', 'refs' => [ 'DriftCheckBias$ConfigFile' => 'The bias config file for a model.
', 'DriftCheckExplainability$ConfigFile' => 'The explainability config file for the model.
', ], ], 'FileSystemAccessMode' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemAccessMode' => '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.
The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
', 'refs' => [ 'KernelGatewayImageConfig$FileSystemConfig' => 'The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
', ], ], 'FileSystemDataSource' => [ 'base' => 'Specifies a file system data source for a channel.
', 'refs' => [ 'DataSource$FileSystemDataSource' => 'The file system that is associated with a channel.
', ], ], 'FileSystemId' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemId' => 'The file system id.
', ], ], 'FileSystemType' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemType' => 'The file system type.
', ], ], 'FillingTransformationMap' => [ 'base' => NULL, 'refs' => [ 'FillingTransformations$value' => NULL, ], ], 'FillingTransformationValue' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$value' => NULL, ], ], 'FillingTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Filling' => '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 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>.
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 filter objects.
', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'Filter$Value' => '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.
The best candidate result from an AutoML training job.
', 'refs' => [ 'AutoMLCandidate$FinalAutoMLJobObjectiveMetric' => NULL, ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'base' => '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 FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
', ], ], 'FinalMetricDataList' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$FinalMetricDataList' => 'A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.
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.
', ], ], 'FlatInvocations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$FlatInvocations' => '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.
The value of the metric.
', 'MetricDatum$Value' => 'The value of the metric.
', 'RecommendationMetrics$CostPerHour' => 'Defines the cost per hour for the instance.
', 'RecommendationMetrics$CostPerInference' => 'Defines the cost per inference for the instance .
', ], ], 'FlowDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionResponse$FlowDefinitionArn' => 'The Amazon Resource Name (ARN) of the flow definition you create.
', 'DescribeFlowDefinitionResponse$FlowDefinitionArn' => 'The Amazon Resource Name (ARN) of the flow defintion.
', 'FlowDefinitionSummary$FlowDefinitionArn' => 'The Amazon Resource Name (ARN) of the flow definition.
', ], ], 'FlowDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionRequest$FlowDefinitionName' => 'The name of your flow definition.
', 'DeleteFlowDefinitionRequest$FlowDefinitionName' => 'The name of the flow definition you are deleting.
', 'DescribeFlowDefinitionRequest$FlowDefinitionName' => 'The name of the flow definition.
', 'DescribeFlowDefinitionResponse$FlowDefinitionName' => 'The Amazon Resource Name (ARN) of the flow definition.
', 'FlowDefinitionSummary$FlowDefinitionName' => 'The name of the flow definition.
', ], ], 'FlowDefinitionOutputConfig' => [ 'base' => 'Contains information about where human output will be stored.
', 'refs' => [ 'CreateFlowDefinitionRequest$OutputConfig' => 'An object containing information about where the human review results will be uploaded.
', 'DescribeFlowDefinitionResponse$OutputConfig' => 'An object containing information about the output file.
', ], ], 'FlowDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowDefinitionResponse$FlowDefinitionStatus' => 'The status of the flow definition. Valid values are listed below.
', 'FlowDefinitionSummary$FlowDefinitionStatus' => 'The status of the flow definition. Valid values:
', ], ], 'FlowDefinitionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFlowDefinitionsResponse$FlowDefinitionSummaries' => 'An array of objects describing the flow definitions.
', ], ], 'FlowDefinitionSummary' => [ 'base' => 'Contains summary information about the flow definition.
', 'refs' => [ 'FlowDefinitionSummaries$member' => NULL, ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskAvailabilityLifetimeInSeconds' => 'The length of time that a task remains available for review by human workers.
', ], ], 'FlowDefinitionTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskCount' => '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.
A description for the human worker task.
', ], ], 'FlowDefinitionTaskKeyword' => [ 'base' => NULL, 'refs' => [ 'FlowDefinitionTaskKeywords$member' => NULL, ], ], 'FlowDefinitionTaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskKeywords' => 'Keywords used to describe the task so that workers can discover the task.
', ], ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTimeLimitInSeconds' => 'The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
', ], ], 'FlowDefinitionTaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTitle' => 'A title for the human worker task.
', ], ], 'ForecastFrequency' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastFrequency' => 'The 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 the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.
', ], ], 'ForecastQuantile' => [ 'base' => NULL, 'refs' => [ 'ForecastQuantiles$member' => NULL, ], ], 'ForecastQuantiles' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastQuantiles' => '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.
Identifies the framework in which the model was trained. For example: TENSORFLOW.
', ], ], 'FrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'InputConfig$FrameworkVersion' => '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.
', ], ], 'GenerateCandidateDefinitionsOnly' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$GenerateCandidateDefinitionsOnly' => 'Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
', 'DescribeAutoMLJobResponse$GenerateCandidateDefinitionsOnly' => 'Indicates whether the output for an AutoML job generates candidate definitions only.
', 'TabularJobConfig$GenerateCandidateDefinitionsOnly' => 'Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
', ], ], 'GetDeviceFleetReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDeviceFleetReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GitConfig' => [ 'base' => 'Specifies configuration details for a Git repository in your Amazon Web Services account.
', 'refs' => [ 'CodeRepositorySummary$GitConfig' => '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.
', 'CreateCodeRepositoryInput$GitConfig' => 'Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.
', 'DescribeCodeRepositoryOutput$GitConfig' => '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.
', ], ], 'GitConfigForUpdate' => [ 'base' => 'Specifies configuration details for a Git repository when the repository is updated.
', 'refs' => [ 'UpdateCodeRepositoryInput$GitConfig' => '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}
The URL where the Git repository is located.
', ], ], 'Group' => [ 'base' => NULL, 'refs' => [ 'Groups$member' => NULL, ], ], 'GroupingAttributeName' => [ 'base' => NULL, 'refs' => [ 'GroupingAttributeNames$member' => NULL, ], ], 'GroupingAttributeNames' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$GroupingAttributeNames' => '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.
', ], ], 'Groups' => [ 'base' => NULL, 'refs' => [ 'OidcMemberDefinition$Groups' => '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.
', ], ], 'HookParameters' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$HookParameters' => 'Configuration information for the Amazon SageMaker Debugger hook parameters.
', ], ], 'Horovod' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Horovod' => 'Indicates Horovod compatibility.
', 'DescribeImageVersionResponse$Horovod' => 'Indicates Horovod compatibility.
', 'UpdateImageVersionRequest$Horovod' => 'Indicates Horovod compatibility.
', ], ], 'HubArn' => [ 'base' => NULL, 'refs' => [ 'CreateHubResponse$HubArn' => 'The Amazon Resource Name (ARN) of the hub.
', 'DescribeHubContentResponse$HubArn' => 'The Amazon Resource Name (ARN) of the hub that contains the content.
', 'DescribeHubResponse$HubArn' => 'The Amazon Resource Name (ARN) of the hub.
', 'HubInfo$HubArn' => 'The Amazon Resource Name (ARN) of the hub.
', 'ImportHubContentResponse$HubArn' => 'The ARN of the hub that the content was imported into.
', 'UpdateHubResponse$HubArn' => 'The Amazon Resource Name (ARN) of the updated hub.
', ], ], 'HubContentArn' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentArn' => 'The Amazon Resource Name (ARN) of the hub content.
', 'HubContentInfo$HubContentArn' => 'The Amazon Resource Name (ARN) of the hub content.
', 'ImportHubContentResponse$HubContentArn' => 'The ARN of the hub content that was imported.
', ], ], 'HubContentDependency' => [ 'base' => 'Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.
', 'refs' => [ 'HubContentDependencyList$member' => NULL, ], ], 'HubContentDependencyList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDependencies' => 'The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
', ], ], 'HubContentDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDescription' => 'A description of the hub content.
', 'HubContentInfo$HubContentDescription' => 'A description of the hub content.
', 'ImportHubContentRequest$HubContentDescription' => 'A description of the hub content to import.
', ], ], 'HubContentDisplayName' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDisplayName' => 'The display name of the hub content.
', 'HubContentInfo$HubContentDisplayName' => 'The display name of the hub content.
', 'ImportHubContentRequest$HubContentDisplayName' => 'The display name of the hub content to import.
', ], ], 'HubContentDocument' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDocument' => 'The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
', 'ImportHubContentRequest$HubContentDocument' => 'The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
', ], ], 'HubContentInfo' => [ 'base' => 'Information about hub content.
', 'refs' => [ 'HubContentInfoList$member' => NULL, ], ], 'HubContentInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsResponse$HubContentSummaries' => 'The summaries of the listed hub content versions.
', 'ListHubContentsResponse$HubContentSummaries' => 'The summaries of the listed hub content.
', ], ], 'HubContentMarkdown' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentMarkdown' => 'A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
', 'ImportHubContentRequest$HubContentMarkdown' => 'A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
', ], ], 'HubContentName' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentName' => 'The name of the content that you want to delete from a hub.
', 'DescribeHubContentRequest$HubContentName' => 'The name of the content to describe.
', 'DescribeHubContentResponse$HubContentName' => 'The name of the hub content.
', 'HubContentInfo$HubContentName' => 'The name of the hub content.
', 'ImportHubContentRequest$HubContentName' => 'The name of the hub content to import.
', 'ListHubContentVersionsRequest$HubContentName' => 'The name of the hub content.
', ], ], 'HubContentSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentSearchKeywords' => 'The searchable keywords for the hub content.
', 'HubContentInfo$HubContentSearchKeywords' => 'The searchable keywords for the hub content.
', 'ImportHubContentRequest$HubContentSearchKeywords' => 'The searchable keywords of the hub content.
', ], ], 'HubContentSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsRequest$SortBy' => 'Sort hub content versions by either name or creation time.
', 'ListHubContentsRequest$SortBy' => 'Sort hub content versions by either name or creation time.
', ], ], 'HubContentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentStatus' => 'The status of the hub content.
', 'HubContentInfo$HubContentStatus' => 'The status of the hub content.
', ], ], 'HubContentType' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentType' => 'The type of content that you want to delete from a hub.
', 'DescribeHubContentRequest$HubContentType' => 'The type of content in the hub.
', 'DescribeHubContentResponse$HubContentType' => 'The type of hub content.
', 'HubContentInfo$HubContentType' => 'The type of hub content.
', 'ImportHubContentRequest$HubContentType' => 'The type of hub content to import.
', 'ListHubContentVersionsRequest$HubContentType' => 'The type of hub content to list versions of.
', 'ListHubContentsRequest$HubContentType' => 'The type of hub content to list.
', ], ], 'HubContentVersion' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentVersion' => 'The version of the content that you want to delete from a hub.
', 'DescribeHubContentRequest$HubContentVersion' => 'The version of the content to describe.
', 'DescribeHubContentResponse$HubContentVersion' => 'The version of the hub content.
', 'HubContentInfo$HubContentVersion' => 'The version of the hub content.
', 'ImportHubContentRequest$HubContentVersion' => 'The version of the hub content to import.
', 'ListHubContentVersionsRequest$MinVersion' => 'The lower bound of the hub content versions to list.
', ], ], 'HubDescription' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDescription' => 'A description of the hub.
', 'DescribeHubResponse$HubDescription' => 'A description of the hub.
', 'HubInfo$HubDescription' => 'A description of the hub.
', 'UpdateHubRequest$HubDescription' => 'A description of the updated hub.
', ], ], 'HubDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDisplayName' => 'The display name of the hub.
', 'DescribeHubResponse$HubDisplayName' => 'The display name of the hub.
', 'HubInfo$HubDisplayName' => 'The display name of the hub.
', 'UpdateHubRequest$HubDisplayName' => 'The display name of the hub.
', ], ], 'HubInfo' => [ 'base' => 'Information about a hub.
', 'refs' => [ 'HubInfoList$member' => NULL, ], ], 'HubInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubsResponse$HubSummaries' => 'The summaries of the listed hubs.
', ], ], 'HubName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubName' => 'The name of the hub to create.
', 'DeleteHubContentRequest$HubName' => 'The name of the hub that you want to delete content in.
', 'DeleteHubRequest$HubName' => 'The name of the hub to delete.
', 'DescribeHubContentRequest$HubName' => 'The name of the hub that contains the content to describe.
', 'DescribeHubContentResponse$HubName' => 'The name of the hub that contains the content.
', 'DescribeHubRequest$HubName' => 'The name of the hub to describe.
', 'DescribeHubResponse$HubName' => 'The name of the hub.
', 'HubInfo$HubName' => 'The name of the hub.
', 'ImportHubContentRequest$HubName' => 'The name of the hub to import content into.
', 'ListHubContentVersionsRequest$HubName' => 'The name of the hub to list the content versions of.
', 'ListHubContentsRequest$HubName' => 'The name of the hub to list the contents of.
', 'UpdateHubRequest$HubName' => 'The name of the hub to update.
', ], ], 'HubS3StorageConfig' => [ 'base' => 'The Amazon S3 storage configuration of a hub.
', 'refs' => [ 'CreateHubRequest$S3StorageConfig' => 'The Amazon S3 storage configuration for the hub.
', 'DescribeHubResponse$S3StorageConfig' => 'The Amazon S3 storage configuration for the hub.
', ], ], 'HubSearchKeyword' => [ 'base' => NULL, 'refs' => [ 'HubContentSearchKeywordList$member' => NULL, 'HubSearchKeywordList$member' => NULL, ], ], 'HubSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubSearchKeywords' => 'The searchable keywords for the hub.
', 'DescribeHubResponse$HubSearchKeywords' => 'The searchable keywords for the hub.
', 'HubInfo$HubSearchKeywords' => 'The searchable keywords for the hub.
', 'UpdateHubRequest$HubSearchKeywords' => 'The searchable keywords for the hub.
', ], ], 'HubSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubsRequest$SortBy' => 'Sort hubs by either name or creation time.
', ], ], 'HubStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubResponse$HubStatus' => 'The status of the hub.
', 'HubInfo$HubStatus' => 'The status of the hub.
', ], ], 'HumanLoopActivationConditions' => [ 'base' => NULL, 'refs' => [ 'HumanLoopActivationConditionsConfig$HumanLoopActivationConditions' => '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.
', ], ], 'HumanLoopActivationConditionsConfig' => [ 'base' => 'Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.
', 'refs' => [ 'HumanLoopActivationConfig$HumanLoopActivationConditionsConfig' => 'Container structure for defining under what conditions SageMaker creates a human loop.
', ], ], 'HumanLoopActivationConfig' => [ 'base' => 'Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.
An object containing information about the events that trigger a human workflow.
', 'DescribeFlowDefinitionResponse$HumanLoopActivationConfig' => 'An object containing information about what triggers a human review workflow.
', ], ], 'HumanLoopConfig' => [ 'base' => 'Describes the work to be performed by human workers.
', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopConfig' => 'An object containing information about the tasks the human reviewers will perform.
', 'DescribeFlowDefinitionResponse$HumanLoopConfig' => 'An object containing information about who works on the task, the workforce task price, and other task details.
', ], ], 'HumanLoopRequestSource' => [ 'base' => 'Container for configuring the source of human task requests.
', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopRequestSource' => 'Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
', 'DescribeFlowDefinitionResponse$HumanLoopRequestSource' => 'Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
', ], ], 'HumanTaskConfig' => [ 'base' => 'Information required for human workers to complete a labeling task.
', 'refs' => [ 'CreateLabelingJobRequest$HumanTaskConfig' => 'Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
', 'DescribeLabelingJobResponse$HumanTaskConfig' => 'Configuration information required for human workers to complete a labeling task.
', ], ], 'HumanTaskUiArn' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiResponse$HumanTaskUiArn' => 'The Amazon Resource Name (ARN) of the human review workflow user interface you create.
', 'DescribeHumanTaskUiResponse$HumanTaskUiArn' => 'The Amazon Resource Name (ARN) of the human task user interface (worker task template).
', 'HumanLoopConfig$HumanTaskUiArn' => '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.
', 'HumanTaskUiSummary$HumanTaskUiArn' => 'The Amazon Resource Name (ARN) of the human task user interface.
', 'RenderUiTemplateRequest$HumanTaskUiArn' => '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.
', 'UiConfig$HumanTaskUiArn' => '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
The name of the user interface you are creating.
', 'DeleteHumanTaskUiRequest$HumanTaskUiName' => 'The name of the human task user interface (work task template) you want to delete.
', 'DescribeHumanTaskUiRequest$HumanTaskUiName' => 'The name of the human task user interface (worker task template) you want information about.
', 'DescribeHumanTaskUiResponse$HumanTaskUiName' => 'The name of the human task user interface (worker task template).
', 'HumanTaskUiSummary$HumanTaskUiName' => 'The name of the human task user interface.
', ], ], 'HumanTaskUiStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHumanTaskUiResponse$HumanTaskUiStatus' => 'The status of the human task user interface (worker task template). Valid values are listed below.
', ], ], 'HumanTaskUiSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHumanTaskUisResponse$HumanTaskUiSummaries' => 'An array of objects describing the human task user interfaces.
', ], ], 'HumanTaskUiSummary' => [ 'base' => 'Container for human task user interface information.
', 'refs' => [ 'HumanTaskUiSummaries$member' => NULL, ], ], 'HyperParameterAlgorithmSpecification' => [ 'base' => 'Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.
', 'refs' => [ 'HyperParameterTrainingJobDefinition$AlgorithmSpecification' => 'The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
', ], ], 'HyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameters$key' => NULL, ], ], 'HyperParameterScalingType' => [ 'base' => NULL, 'refs' => [ 'ContinuousParameterRange$ScalingType' => 'The 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.
The 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.
Defines a hyperparameter to be used by an algorithm.
', 'refs' => [ 'HyperParameterSpecifications$member' => NULL, ], ], 'HyperParameterSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedHyperParameters' => 'A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>
Defines the training jobs launched by a hyperparameter tuning job.
', 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinition' => '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.
', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinition' => 'The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
', 'HyperParameterTrainingJobDefinitions$member' => NULL, 'HyperParameterTuningJobSearchEntity$TrainingJobDefinition' => NULL, ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$DefinitionName' => 'The job definition name.
', 'HyperParameterTrainingJobSummary$TrainingJobDefinitionName' => 'The training job definition name.
', ], ], 'HyperParameterTrainingJobDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinitions' => 'A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions' => 'A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
', 'HyperParameterTuningJobSearchEntity$TrainingJobDefinitions' => 'The job definitions included in a hyperparameter tuning job.
', ], ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$key' => NULL, ], ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$Environment' => '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.
A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.
The container for the summary information about a training job.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$BestTrainingJob' => 'A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
', 'DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob' => '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 strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.
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).
', 'refs' => [ 'HyperParameterTuningInstanceConfigs$member' => NULL, ], ], 'HyperParameterTuningInstanceConfigs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$InstanceConfigs' => '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 Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => 'The Amazon Resource Name (ARN) of the tuning job.
', 'DescribeTrainingJobResponse$TuningJobArn' => 'The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobArn' => 'The Amazon Resource Name (ARN) of a hyperparameter tuning job.
', 'HyperParameterTuningJobSummary$HyperParameterTuningJobArn' => 'The Amazon Resource Name (ARN) of the tuning job.
', 'TrainingJob$TuningJobArn' => 'The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
', 'TuningJobStepMetaData$Arn' => 'The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
', ], ], 'HyperParameterTuningJobCompletionDetails' => [ 'base' => 'A structure that contains runtime information about both current and completed hyperparameter tuning jobs.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TuningJobCompletionDetails' => '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.
', 'HyperParameterTuningJobSearchEntity$TuningJobCompletionDetails' => 'Information about either a current or completed hyperparameter tuning job.
', ], ], 'HyperParameterTuningJobConfig' => [ 'base' => 'Configures a hyperparameter tuning job.
', 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig' => '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.
', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig' => 'The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobConfig' => NULL, ], ], 'HyperParameterTuningJobConsumedResources' => [ 'base' => 'The total resources consumed by your hyperparameter tuning job.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ConsumedResources' => NULL, 'HyperParameterTuningJobSearchEntity$ConsumedResources' => 'The total amount of resources consumed by a hyperparameter tuning job.
', ], ], 'HyperParameterTuningJobName' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '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.
', 'DescribeHyperParameterTuningJobRequest$HyperParameterTuningJobName' => 'The name of the tuning job.
', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobName' => 'The name of the hyperparameter tuning job.
', 'HyperParameterTrainingJobSummary$TuningJobName' => 'The HyperParameter tuning job that launched the training job.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobName' => 'The name of a hyperparameter tuning job.
', 'HyperParameterTuningJobSummary$HyperParameterTuningJobName' => 'The name of the tuning job.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$HyperParameterTuningJobName' => 'The name of the tuning job whose training jobs you want to list.
', 'ParentHyperParameterTuningJob$HyperParameterTuningJobName' => 'The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
', 'StopHyperParameterTuningJobRequest$HyperParameterTuningJobName' => 'The name of the tuning job to stop.
', ], ], 'HyperParameterTuningJobObjective' => [ 'base' => '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.
The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.
', 'HyperParameterTuningJobObjectives$member' => NULL, ], ], 'HyperParameterTuningJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$Type' => 'Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
', 'HyperParameterTuningJobObjective$Type' => 'Whether to minimize or maximize the objective metric.
', ], ], 'HyperParameterTuningJobObjectives' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTuningJobObjectiveMetrics' => 'A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.
', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'base' => 'An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.
', 'refs' => [ 'SearchRecord$HyperParameterTuningJob' => 'The properties of a hyperparameter tuning job.
', ], ], 'HyperParameterTuningJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsRequest$SortBy' => 'The field to sort results by. The default is Name.
The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobStatus' => 'The status of a hyperparameter tuning job.
', 'HyperParameterTuningJobSummary$HyperParameterTuningJobStatus' => 'The status of the tuning job.
', 'ListHyperParameterTuningJobsRequest$StatusEquals' => 'A filter that returns only tuning jobs with the specified status.
', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'base' => '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 configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.
The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.
', 'refs' => [ 'HyperParameterTuningJobConfig$Strategy' => '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.
', 'HyperParameterTuningJobSummary$Strategy' => 'Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.
', ], ], 'HyperParameterTuningJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsResponse$HyperParameterTuningJobSummaries' => 'A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.
Provides summary information about a hyperparameter tuning job.
', 'refs' => [ 'HyperParameterTuningJobSummaries$member' => NULL, ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'base' => 'Specifies 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.
Specifies 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.
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.
', 'HyperParameterTuningJobSearchEntity$WarmStartConfig' => NULL, ], ], 'HyperParameterTuningJobWarmStartType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$WarmStartType' => 'Specifies 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.
The maximum time in seconds that a hyperparameter tuning job can run.
', ], ], 'HyperParameterTuningResourceConfig' => [ 'base' => '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 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).
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
', 'HyperParameters$value' => NULL, ], ], 'HyperParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$HyperParameters' => 'Algorithm-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 field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
Algorithm-specific parameters.
', 'HyperParameterTrainingJobDefinition$StaticHyperParameters' => 'Specifies the values of hyperparameters that do not change for the tuning job.
', 'HyperParameterTrainingJobSummary$TunedHyperParameters' => 'A list of the hyperparameters for which you specified ranges to search.
', 'TrainingJob$HyperParameters' => 'Algorithm-specific parameters.
', 'TrainingJobDefinition$HyperParameters' => 'The hyperparameters used for the training job.
', ], ], 'HyperbandStrategyConfig' => [ 'base' => '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 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 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, HyperbandTrainingJ 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 distributive 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 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 IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.
', 'refs' => [ 'UserContext$IamIdentity' => 'The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
', ], ], 'IdempotencyToken' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
', 'DeletePipelineRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
', 'RetryPipelineExecutionRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
', 'SendPipelineExecutionStepFailureRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
', 'SendPipelineExecutionStepSuccessRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
', 'StartPipelineExecutionRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
', 'StopPipelineExecutionRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
', ], ], 'Image' => [ 'base' => 'A SageMaker image. A SageMaker 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 ImageVersion.
The ARN of the image.
', 'DescribeImageResponse$ImageArn' => 'The ARN of the image.
', 'DescribeImageVersionResponse$ImageArn' => 'The ARN of the image the version is based on.
', 'Image$ImageArn' => 'The ARN of the image.
', 'ImageVersion$ImageArn' => 'The ARN of the image the version is based on.
', 'ResourceSpec$SageMakerImageArn' => 'The ARN of the SageMaker image that the image version belongs to.
', 'UpdateImageResponse$ImageArn' => 'The ARN of the image.
', ], ], 'ImageBaseImage' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$BaseImage' => 'The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
The registry path of the container image on which this image version is based.
', ], ], 'ImageClassificationJobConfig' => [ 'base' => 'Stores the configuration information for the image classification problem of an AutoML job V2.
', 'refs' => [ 'AutoMLProblemTypeConfig$ImageClassificationJobConfig' => 'Settings used to configure an AutoML job V2 for the image classification problem type.
', ], ], 'ImageConfig' => [ 'base' => 'Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).
', 'refs' => [ 'ContainerDefinition$ImageConfig' => 'Specifies 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 registry path of the container image that contains this image version.
', ], ], 'ImageDeleteProperty' => [ 'base' => NULL, 'refs' => [ 'ImageDeletePropertyList$member' => NULL, ], ], 'ImageDeletePropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateImageRequest$DeleteProperties' => 'A list of properties to delete. Only the Description and DisplayName properties can be deleted.
The description of the image.
', 'DescribeImageResponse$Description' => 'The description of the image.
', 'Image$Description' => 'The description of the image.
', 'UpdateImageRequest$Description' => 'The new description for the image.
', ], ], 'ImageDigest' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$ImageDigest' => 'An MD5 hash of the training algorithm that identifies the Docker image used for training.
', 'TrainingSpecification$TrainingImageDigest' => 'An MD5 hash of the training algorithm that identifies the Docker image used for training.
', ], ], 'ImageDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$DisplayName' => 'The display name of the image. If not provided, ImageName is displayed.
The name of the image as displayed.
', 'Image$DisplayName' => 'The name of the image as displayed.
', 'UpdateImageRequest$DisplayName' => 'The new display name for the image.
', ], ], 'ImageName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$ImageName' => 'The name of the image. Must be unique to your account.
', 'CreateImageVersionRequest$ImageName' => 'The ImageName of the Image to create a version of.
The name of the CustomImage. Must be unique to your account.
', 'DeleteImageRequest$ImageName' => 'The name of the image to delete.
', 'DeleteImageVersionRequest$ImageName' => 'The name of the image to delete.
', 'DescribeImageRequest$ImageName' => 'The name of the image to describe.
', 'DescribeImageResponse$ImageName' => 'The name of the image.
', 'DescribeImageVersionRequest$ImageName' => 'The name of the image.
', 'Image$ImageName' => 'The name of the image.
', 'ListAliasesRequest$ImageName' => 'The name of the image.
', 'ListImageVersionsRequest$ImageName' => 'The name of the image to list the versions of.
', 'UpdateImageRequest$ImageName' => 'The name of the image to update.
', 'UpdateImageVersionRequest$ImageName' => 'The name of the image.
', ], ], 'ImageNameContains' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$NameContains' => 'A filter that returns only images whose name contains the specified string.
', ], ], 'ImageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortBy' => 'The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
The status of the image.
', 'Image$ImageStatus' => 'The status of the image.
', ], ], 'ImageUri' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ImageUri' => 'The container image to be run by the processing job.
', 'DataQualityAppSpecification$ImageUri' => 'The container image that the data quality monitoring job runs.
', 'ModelBiasAppSpecification$ImageUri' => 'The container image to be run by the model bias job.
', 'ModelExplainabilityAppSpecification$ImageUri' => 'The container image to be run by the model explainability job.
', 'ModelQualityAppSpecification$ImageUri' => 'The address of the container image that the monitoring job runs.
', 'MonitoringAppSpecification$ImageUri' => 'The container image to be run by the monitoring job.
', ], ], 'ImageVersion' => [ 'base' => 'A version of a SageMaker Image. A version represents an existing container image.
The ARN of the image version.
', 'DescribeImageVersionResponse$ImageVersionArn' => 'The ARN of the version.
', 'ImageVersion$ImageVersionArn' => 'The ARN of the version.
', 'ResourceSpec$SageMakerImageVersionArn' => 'The ARN of the image version created on the instance.
', 'UpdateImageVersionResponse$ImageVersionArn' => 'The ARN of the image version.
', ], ], 'ImageVersionNumber' => [ 'base' => NULL, 'refs' => [ 'CustomImage$ImageVersionNumber' => 'The version number of the CustomImage.
', 'DeleteImageVersionRequest$Version' => 'The version to delete.
', 'DescribeImageVersionRequest$Version' => 'The version of the image. If not specified, the latest version is described.
', 'DescribeImageVersionResponse$Version' => 'The version number.
', 'ImageVersion$Version' => 'The version number.
', 'ListAliasesRequest$Version' => 'The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
', 'UpdateImageVersionRequest$Version' => 'The version of the image.
', ], ], 'ImageVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortBy' => 'The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
The status of the version.
', 'ImageVersion$ImageVersionStatus' => 'The status of the version.
', ], ], 'ImageVersions' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsResponse$ImageVersions' => 'A list of versions and their properties.
', ], ], 'Images' => [ 'base' => NULL, 'refs' => [ 'ListImagesResponse$Images' => 'A list of images and their properties.
', ], ], 'ImportHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'InferenceExecutionConfig' => [ 'base' => 'Specifies details about how containers in a multi-container endpoint are run.
', 'refs' => [ 'CreateModelInput$InferenceExecutionConfig' => 'Specifies details of how containers in a multi-container endpoint are called.
', 'DescribeModelOutput$InferenceExecutionConfig' => 'Specifies details of how containers in a multi-container endpoint are called.
', 'Model$InferenceExecutionConfig' => NULL, ], ], 'InferenceExecutionMode' => [ 'base' => NULL, 'refs' => [ 'InferenceExecutionConfig$Mode' => '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.
The ARN for your inference experiment.
', 'DeleteInferenceExperimentResponse$InferenceExperimentArn' => 'The ARN of the deleted inference experiment.
', 'DescribeInferenceExperimentResponse$Arn' => 'The ARN of the inference experiment being described.
', 'StartInferenceExperimentResponse$InferenceExperimentArn' => 'The ARN of the started inference experiment to start.
', 'StopInferenceExperimentResponse$InferenceExperimentArn' => 'The ARN of the stopped inference experiment.
', 'UpdateInferenceExperimentResponse$InferenceExperimentArn' => 'The ARN of the updated inference experiment.
', ], ], 'InferenceExperimentDataStorageConfig' => [ 'base' => 'The Amazon S3 location and configuration for storing inference request and response data.
', 'refs' => [ 'CreateInferenceExperimentRequest$DataStorageConfig' => '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.
', 'DescribeInferenceExperimentResponse$DataStorageConfig' => 'The Amazon S3 location and configuration for storing inference request and response data.
', 'UpdateInferenceExperimentRequest$DataStorageConfig' => 'The Amazon S3 location and configuration for storing inference request and response data.
', ], ], 'InferenceExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Description' => 'A description for the inference experiment.
', 'DescribeInferenceExperimentResponse$Description' => 'The description of the inference experiment.
', 'InferenceExperimentSummary$Description' => 'The description of the inference experiment.
', 'UpdateInferenceExperimentRequest$Description' => 'The description of the inference experiment.
', ], ], 'InferenceExperimentList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsResponse$InferenceExperiments' => 'List of inference experiments.
', ], ], 'InferenceExperimentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Name' => 'The name for the inference experiment.
', 'DeleteInferenceExperimentRequest$Name' => 'The name of the inference experiment you want to delete.
', 'DescribeInferenceExperimentRequest$Name' => 'The name of the inference experiment to describe.
', 'DescribeInferenceExperimentResponse$Name' => 'The name of the inference experiment.
', 'InferenceExperimentSummary$Name' => 'The name of the inference experiment.
', 'StartInferenceExperimentRequest$Name' => 'The name of the inference experiment to start.
', 'StopInferenceExperimentRequest$Name' => 'The name of the inference experiment to stop.
', 'UpdateInferenceExperimentRequest$Name' => 'The name of the inference experiment to be updated.
', ], ], 'InferenceExperimentSchedule' => [ 'base' => 'The start and end times of an inference experiment.
The maximum duration that you can set for an inference experiment is 30 days.
', 'refs' => [ 'CreateInferenceExperimentRequest$Schedule' => '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.
', 'DescribeInferenceExperimentResponse$Schedule' => 'The duration for which the inference experiment ran or will run.
', 'InferenceExperimentSummary$Schedule' => '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.
', 'UpdateInferenceExperimentRequest$Schedule' => ' 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.
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.
The status of the inference experiment.
', 'ListInferenceExperimentsRequest$StatusEquals' => 'Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.
', ], ], 'InferenceExperimentStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$StatusReason' => ' The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
The error message for the inference experiment status result.
', 'StopInferenceExperimentRequest$Reason' => 'The reason for stopping the experiment.
', ], ], 'InferenceExperimentStopDesiredState' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$DesiredState' => 'The desired state of the experiment after stopping. The possible states are the following:
Completed: The experiment completed successfully
Cancelled: The experiment was canceled
Lists a summary of properties of an inference experiment.
', 'refs' => [ 'InferenceExperimentList$member' => NULL, ], ], 'InferenceExperimentType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Type' => '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.
The type of the inference experiment.
', 'InferenceExperimentSummary$Type' => 'The type of the inference experiment.
', 'ListInferenceExperimentsRequest$Type' => 'Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.
', ], ], 'InferenceImage' => [ 'base' => NULL, 'refs' => [ 'DescribeCompilationJobResponse$InferenceImage' => 'The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.
', ], ], 'InferenceMetrics' => [ 'base' => 'The metrics for an existing endpoint compared in an Inference Recommender job.
', 'refs' => [ 'EndpointPerformance$Metrics' => 'The metrics for an existing endpoint.
', 'RecommendationJobInferenceBenchmark$EndpointMetrics' => NULL, ], ], 'InferenceRecommendation' => [ 'base' => 'A list of recommendations made by Amazon SageMaker Inference Recommender.
', 'refs' => [ 'InferenceRecommendations$member' => NULL, ], ], 'InferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$InferenceRecommendations' => 'The recommendations made by Inference Recommender.
', ], ], 'InferenceRecommendationsJob' => [ 'base' => 'A structure that contains a list of recommendation jobs.
', 'refs' => [ 'InferenceRecommendationsJobs$member' => NULL, ], ], 'InferenceRecommendationsJobStep' => [ 'base' => 'A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.
A list of all subtask details in Inference Recommender.
', ], ], 'InferenceRecommendationsJobs' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsResponse$InferenceRecommendationsJobs' => 'The recommendations created from the Amazon SageMaker Inference Recommender job.
', ], ], 'InferenceSpecification' => [ 'base' => 'Defines how to perform inference generation after a training job is run.
', 'refs' => [ 'BatchDescribeModelPackageSummary$InferenceSpecification' => NULL, 'CreateAlgorithmInput$InferenceSpecification' => 'Specifies 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 details about inference jobs that can be run with models based on this model package, including the following:
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.
Details about inference jobs that the algorithm runs.
', 'DescribeModelPackageOutput$InferenceSpecification' => 'Details about inference jobs that can be run with models based on this model package.
', 'ModelPackage$InferenceSpecification' => 'Defines how to perform inference generation after a training job is run.
', ], ], 'InferenceSpecificationName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$InferenceSpecificationName' => 'The inference specification name in the model package version.
', 'EndpointInputConfiguration$InferenceSpecificationName' => 'The inference specification name in the model package version.
', 'ModelConfiguration$InferenceSpecificationName' => 'The inference specification name in the model package version.
', ], ], 'InitialInstanceCount' => [ 'base' => NULL, 'refs' => [ 'EndpointOutputConfiguration$InitialInstanceCount' => 'The number of instances recommended to launch initially.
', ], ], 'InitialNumberOfUsers' => [ 'base' => NULL, 'refs' => [ 'Phase$InitialNumberOfUsers' => 'Specifies how many concurrent users to start with. The value should be between 1 and 3.
', ], ], 'InitialTaskCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$InitialInstanceCount' => 'Number of instances to launch initially.
', ], ], 'InputConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateCompilationJobRequest$InputConfig' => '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.
', 'DescribeCompilationJobResponse$InputConfig' => '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.
', ], ], 'InputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$InputDataConfig' => '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.
', 'DescribeTrainingJobResponse$InputDataConfig' => 'An array of Channel objects that describes each data input channel.
An array of Channel objects that specify the input for the training jobs that the tuning job launches.
', 'TrainingJob$InputDataConfig' => '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.
', 'TrainingJobDefinition$InputDataConfig' => 'An array of Channel objects, each of which specifies an input source.
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.
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.
', ], ], 'InstanceGroup' => [ 'base' => 'Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .
', 'refs' => [ 'InstanceGroups$member' => NULL, ], ], 'InstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$InstanceGroupName' => 'Specifies the name of the instance group.
', 'InstanceGroupNames$member' => NULL, ], ], 'InstanceGroupNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$InstanceGroupNames' => 'A list of names of instance groups that get data from the S3 data source.
', ], ], 'InstanceGroups' => [ 'base' => NULL, 'refs' => [ 'ResourceConfig$InstanceGroups' => 'The configuration of a heterogeneous cluster in JSON format.
', ], ], 'InstanceMetadataServiceConfiguration' => [ 'base' => 'Information on the IMDS configuration of the notebook instance
', 'refs' => [ 'CreateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => 'Information on the IMDS configuration of the notebook instance
', 'DescribeNotebookInstanceOutput$InstanceMetadataServiceConfiguration' => 'Information on the IMDS configuration of the notebook instance
', 'UpdateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => 'Information on the IMDS configuration of the notebook instance
', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$InstanceType' => 'The type of ML compute instance to launch for the notebook instance.
', 'DescribeNotebookInstanceOutput$InstanceType' => 'The type of ML compute instance running on the notebook instance.
', 'NotebookInstanceSummary$InstanceType' => 'The type of ML compute instance that the notebook instance is running on.
', 'RealTimeInferenceConfig$InstanceType' => 'The instance type the model is deployed to.
', 'UpdateNotebookInstanceInput$InstanceType' => 'The Amazon ML compute instance type.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardVersion' => 'The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.
', 'DescribeDeviceResponse$MaxModels' => 'The maximum number of models.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentSuccess' => 'The number of edge devices with the successful deployment.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPending' => 'The number of edge devices yet to pick up deployment, or in progress.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentFailed' => 'The number of edge devices that failed the deployment.
', 'DescribeModelCardExportJobResponse$ModelCardVersion' => 'The version of the model card that the model export job exports.
', 'DescribeModelCardRequest$ModelCardVersion' => 'The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
', 'DescribeModelCardResponse$ModelCardVersion' => 'The version of the model card.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentSuccess' => 'The number of edge devices with the successful deployment.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentPending' => 'The number of edge devices yet to pick up the deployment, or in progress.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentFailed' => 'The number of edge devices that failed the deployment.
', 'EdgeDeploymentStatus$EdgeDeploymentSuccessInStage' => 'The number of edge devices with the successful deployment in the current stage.
', 'EdgeDeploymentStatus$EdgeDeploymentPendingInStage' => 'The number of edge devices yet to pick up the deployment in current stage, or in progress.
', 'EdgeDeploymentStatus$EdgeDeploymentFailedInStage' => 'The number of edge devices that failed the deployment in current stage.
', 'HyperParameterTuningJobCompletionDetails$NumberOfTrainingJobsObjectiveNotImproving' => '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.
', 'HyperParameterTuningJobConsumedResources$RuntimeInSeconds' => 'The wall clock runtime in seconds used by your hyperparameter tuning job.
', 'InferenceMetrics$MaxInvocations' => 'The expected maximum number of requests per minute for the instance.
', 'InferenceMetrics$ModelLatency' => 'The expected model latency at maximum invocations per minute for the instance.
', 'ListModelCardExportJobsRequest$ModelCardVersion' => 'List export jobs for the model card with the specified version.
', 'ModelCard$ModelCardVersion' => 'The version of the model card.
', 'ModelCardExportJobSummary$ModelCardVersion' => 'The version of the model card that the export job exports.
', 'ModelCardVersionSummary$ModelCardVersion' => 'A version of the model card.
', 'ModelDashboardModelCard$ModelCardVersion' => 'The model card version.
', 'ModelLatencyThreshold$ValueInMilliseconds' => 'The model latency percentile value in milliseconds.
', 'RecommendationJobStoppingConditions$MaxInvocations' => 'The maximum number of requests per minute expected for the endpoint.
', 'RecommendationMetrics$MaxInvocations' => 'The expected maximum number of requests per minute for the instance.
', 'RecommendationMetrics$ModelLatency' => 'The expected model latency at maximum invocation per minute for the instance.
', ], ], 'IntegerParameterRange' => [ 'base' => 'For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
', 'refs' => [ 'IntegerParameterRanges$member' => NULL, ], ], 'IntegerParameterRangeSpecification' => [ 'base' => 'Defines the possible values for an integer hyperparameter.
', 'refs' => [ 'ParameterRange$IntegerParameterRangeSpecification' => 'A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
', ], ], 'IntegerValue' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$AttemptCount' => 'The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
', ], ], 'InvocationEndTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationEndTime' => 'A timestamp that shows when the benchmark completed.
', 'RecommendationJobInferenceBenchmark$InvocationEndTime' => 'A timestamp that shows when the benchmark completed.
', ], ], 'InvocationStartTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationStartTime' => 'A timestamp that shows when the benchmark started.
', 'RecommendationJobInferenceBenchmark$InvocationStartTime' => 'A timestamp that shows when the benchmark started.
', ], ], 'InvocationsMaxRetries' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsMaxRetries' => 'The maximum number of retries when invocation requests are failing. The default value is 3.
', ], ], 'InvocationsTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsTimeoutInSeconds' => 'The timeout value in seconds for an invocation request. The default value is 600.
', ], ], 'IotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$IotRoleAlias' => 'The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).
', ], ], 'ItemIdentifierAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$ItemIdentifierAttributeName' => 'The name of the column that represents the set of item identifiers for which you want to predict the target value.
', ], ], 'JobDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$JobDurationInSeconds' => 'Specifies the maximum duration of the job, in seconds. The maximum value is 7200.
', ], ], 'JobReferenceCode' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$JobReferenceCode' => 'A unique identifier for work done as part of a labeling job.
', 'LabelingJobForWorkteamSummary$JobReferenceCode' => 'A unique identifier for a labeling job. You can use this to refer to a specific labeling job.
', ], ], 'JobReferenceCodeContains' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$JobReferenceCodeContains' => 'A filter the limits jobs to only the ones whose job reference code contains the specified string.
', ], ], 'JobType' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$JobType' => 'Indicates SageMaker job type compatibility.
TRAINING: The image version is compatible with SageMaker training jobs.
INFERENCE: The image version is compatible with SageMaker inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
Indicates SageMaker job type compatibility.
TRAINING: The image version is compatible with SageMaker training jobs.
INFERENCE: The image version is compatible with SageMaker inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
Indicates SageMaker job type compatibility.
TRAINING: The image version is compatible with SageMaker training jobs.
INFERENCE: The image version is compatible with SageMaker inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
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.
', ], ], 'JsonContentType' => [ 'base' => NULL, 'refs' => [ 'JsonContentTypes$member' => NULL, ], ], 'JsonContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$JsonContentTypes' => 'The list of all content type headers that SageMaker will treat as JSON and capture accordingly.
', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$InputFilter' => '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 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\']"
The JupyterServer app settings.
', 'refs' => [ 'DefaultSpaceSettings$JupyterServerAppSettings' => NULL, 'SpaceSettings$JupyterServerAppSettings' => NULL, 'UserSettings$JupyterServerAppSettings' => 'The Jupyter server\'s app settings.
', ], ], 'KeepAlivePeriodInSeconds' => [ 'base' => NULL, 'refs' => [ 'ResourceConfig$KeepAlivePeriodInSeconds' => 'The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.
', 'ResourceConfigForUpdate$KeepAlivePeriodInSeconds' => 'The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.
The display name of the kernel.
', ], ], 'KernelGatewayAppSettings' => [ 'base' => 'The KernelGateway app settings.
', 'refs' => [ 'DefaultSpaceSettings$KernelGatewayAppSettings' => NULL, 'SpaceSettings$KernelGatewayAppSettings' => NULL, 'UserSettings$KernelGatewayAppSettings' => 'The kernel gateway app settings.
', ], ], 'KernelGatewayImageConfig' => [ 'base' => 'The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.
', 'refs' => [ 'AppImageConfigDetails$KernelGatewayImageConfig' => 'The configuration for the file system and kernels in the SageMaker image.
', 'CreateAppImageConfigRequest$KernelGatewayImageConfig' => '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.
', 'DescribeAppImageConfigResponse$KernelGatewayImageConfig' => 'The configuration of a KernelGateway app.
', 'UpdateAppImageConfigRequest$KernelGatewayImageConfig' => 'The new KernelGateway app to run on the image.
', ], ], 'KernelName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$Name' => 'The name of the Jupyter kernel in the image. This value is case sensitive.
', ], ], 'KernelSpec' => [ 'base' => 'The specification of a Jupyter kernel.
', 'refs' => [ 'KernelSpecs$member' => NULL, ], ], 'KernelSpecs' => [ 'base' => NULL, 'refs' => [ 'KernelGatewayImageConfig$KernelSpecs' => 'The specification of the Jupyter kernels in the image.
', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$ObjectKey' => 'The object key (or key name) uniquely identifies the object in an S3 bucket.
', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$KmsKeyId' => 'The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.
', 'AthenaDatasetDefinition$KmsKeyId' => '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.
', 'AutoMLOutputDataConfig$KmsKeyId' => 'The Key Management Service (KMS) encryption key ID.
', 'AutoMLSecurityConfig$VolumeKmsKeyId' => 'The key used to encrypt stored data.
', 'BatchDataCaptureConfig$KmsKeyId' => '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
Use KmsKeyId.
SageMaker uses 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, specify a customer managed key.
', 'CreateEdgePackagingJobRequest$ResourceKey' => 'The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.
', 'CreateEndpointConfigInput$KmsKeyId' => '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 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.
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.
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 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.
', 'DataCaptureConfig$KmsKeyId' => 'The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker 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
The KMS key being used to encrypt the data in Amazon S3.
', 'DescribeDomainResponse$HomeEfsFileSystemKmsKeyId' => 'Use KmsKeyId.
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
', 'DescribeEdgePackagingJobResponse$ResourceKey' => 'The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.
', 'DescribeEndpointConfigOutput$KmsKeyId' => 'Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
', 'DescribeInferenceExperimentResponse$KmsKey' => '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.
', 'DescribeNotebookInstanceOutput$KmsKeyId' => 'The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
', 'EdgeOutputConfig$KmsKeyId' => '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.
', 'FlowDefinitionOutputConfig$KmsKeyId' => 'The Amazon Key Management Service (KMS) key ID for server-side encryption.
', 'HyperParameterTuningResourceConfig$VolumeKmsKeyId' => '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 Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.
', 'LabelingJobOutputConfig$KmsKeyId' => '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.
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"
A Key Management Service key ID to use for encrypting a model card.
', 'MonitoringClusterConfig$VolumeKmsKeyId' => '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 model monitoring job.
', 'MonitoringOutputConfig$KmsKeyId' => '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.
', 'OnlineStoreSecurityConfig$KmsKeyId' => '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"
The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker 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 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
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. 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 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.
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.
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, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
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.
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.
', 'RecommendationJobOutputConfig$KmsKeyId' => '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.
', 'RedshiftDatasetDefinition$KmsKeyId' => 'The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
', 'ResourceConfig$VolumeKmsKeyId' => '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 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"
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.
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.
', 'TransformResources$VolumeKmsKeyId' => '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
The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.
', ], ], 'LabelAttributeName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelAttributeName' => '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.
The attribute used as the label in the output manifest file.
', ], ], 'LabelCounter' => [ 'base' => NULL, 'refs' => [ 'LabelCounters$TotalLabeled' => 'The total number of objects labeled.
', 'LabelCounters$HumanLabeled' => 'The total number of objects labeled by a human worker.
', 'LabelCounters$MachineLabeled' => 'The total number of objects labeled by automated data labeling.
', 'LabelCounters$FailedNonRetryableError' => 'The total number of objects that could not be labeled due to an error.
', 'LabelCounters$Unlabeled' => 'The total number of objects not yet labeled.
', 'LabelCountersForWorkteam$HumanLabeled' => 'The total number of data objects labeled by a human worker.
', 'LabelCountersForWorkteam$PendingHuman' => 'The total number of data objects that need to be labeled by a human worker.
', 'LabelCountersForWorkteam$Total' => 'The total number of tasks in the labeling job.
', ], ], 'LabelCounters' => [ 'base' => 'Provides a breakdown of the number of objects labeled.
', 'refs' => [ 'DescribeLabelingJobResponse$LabelCounters' => '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.
', 'LabelingJobSummary$LabelCounters' => 'Counts showing the progress of the labeling job.
', ], ], 'LabelCountersForWorkteam' => [ 'base' => 'Provides counts for human-labeled tasks in the labeling job.
', 'refs' => [ 'LabelingJobForWorkteamSummary$LabelCounters' => 'Provides information about the progress of a labeling job.
', ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'base' => NULL, 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobAlgorithmSpecificationArn' => '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
Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.
Configures the information required to perform automated data labeling.
', 'DescribeLabelingJobResponse$LabelingJobAlgorithmsConfig' => 'Configuration information for automated data labeling.
', ], ], 'LabelingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobResponse$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.
', 'DescribeLabelingJobResponse$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the labeling job.
', 'DescribeTrainingJobResponse$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.
', 'DescribeTransformJobResponse$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
', 'LabelingJobSummary$LabelingJobArn' => 'The Amazon Resource Name (ARN) assigned to the labeling job when it was created.
', 'TrainingJob$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the labeling job.
', 'TransformJob$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the labeling job that created the transform job.
', ], ], 'LabelingJobDataAttributes' => [ 'base' => 'Attributes of the data specified by the customer. Use these to describe the data to be labeled.
', 'refs' => [ 'LabelingJobInputConfig$DataAttributes' => 'Attributes of the data specified by the customer.
', ], ], 'LabelingJobDataSource' => [ 'base' => '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.
The location of the input data.
', ], ], 'LabelingJobForWorkteamSummary' => [ 'base' => 'Provides summary information for a work team.
', 'refs' => [ 'LabelingJobForWorkteamSummaryList$member' => NULL, ], ], 'LabelingJobForWorkteamSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamResponse$LabelingJobSummaryList' => 'An array of LabelingJobSummary objects, each describing a labeling job.
Input configuration information for a labeling job.
', 'refs' => [ 'CreateLabelingJobRequest$InputConfig' => '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.
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.
', 'LabelingJobSummary$InputConfig' => 'Input configuration for the labeling job.
', ], ], 'LabelingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelingJobName' => '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 name of the labeling job to return information for.
', 'DescribeLabelingJobResponse$LabelingJobName' => 'The name assigned to the labeling job when it was created.
', 'LabelingJobForWorkteamSummary$LabelingJobName' => 'The name of the labeling job that the work team is assigned to.
', 'LabelingJobSummary$LabelingJobName' => 'The name of the labeling job.
', 'StopLabelingJobRequest$LabelingJobName' => 'The name of the labeling job to stop.
', ], ], 'LabelingJobOutput' => [ 'base' => 'Specifies the location of the output produced by the labeling job.
', 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobOutput' => 'The location of the output produced by the labeling job.
', 'LabelingJobSummary$LabelingJobOutput' => 'The location of the output produced by the labeling job.
', ], ], 'LabelingJobOutputConfig' => [ 'base' => 'Output configuration information for a labeling job.
', 'refs' => [ 'CreateLabelingJobRequest$OutputConfig' => '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.
', 'DescribeLabelingJobResponse$OutputConfig' => '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.
', ], ], 'LabelingJobResourceConfig' => [ 'base' => 'Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.
', 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobResourceConfig' => 'Provides configuration information for a labeling job.
', ], ], 'LabelingJobS3DataSource' => [ 'base' => 'The Amazon S3 location of the input data objects.
', 'refs' => [ 'LabelingJobDataSource$S3DataSource' => 'The Amazon S3 location of the input data objects.
', ], ], 'LabelingJobSnsDataSource' => [ 'base' => 'An Amazon SNS data source used for streaming labeling jobs.
', 'refs' => [ 'LabelingJobDataSource$SnsDataSource' => 'An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.
', ], ], 'LabelingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobStatus' => 'The processing status of the labeling job.
', 'LabelingJobSummary$LabelingJobStatus' => 'The current status of the labeling job.
', 'ListLabelingJobsRequest$StatusEquals' => 'A filter that retrieves only labeling jobs with a specific status.
', ], ], 'LabelingJobStoppingConditions' => [ 'base' => 'A 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.
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.
', 'DescribeLabelingJobResponse$StoppingConditions' => 'A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
', ], ], 'LabelingJobSummary' => [ 'base' => 'Provides summary information about a labeling job.
', 'refs' => [ 'LabelingJobSummaryList$member' => NULL, ], ], 'LabelingJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsResponse$LabelingJobSummaryList' => 'An array of LabelingJobSummary objects, each describing a labeling job.
The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.
This parameter is required for all labeling jobs. 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 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
The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.
', 'LabelingJobSummary$AnnotationConsolidationLambdaArn' => '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.
', ], ], 'LambdaStepMetadata' => [ 'base' => 'Metadata for a Lambda step.
', 'refs' => [ 'PipelineExecutionStepMetadata$Lambda' => 'The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.
', ], ], 'LastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$LastModifiedTime' => 'The date and time that the Git repository was last modified.
', 'CompilationJobSummary$LastModifiedTime' => 'The time when the model compilation job was last modified.
', 'DescribeCodeRepositoryOutput$LastModifiedTime' => 'The date and time that the repository was last changed.
', 'DescribeCompilationJobResponse$LastModifiedTime' => 'The time that the status of the model compilation job was last modified.
', 'DescribeDomainResponse$LastModifiedTime' => 'The last modified time.
', 'DescribeFeatureGroupResponse$LastModifiedTime' => 'A timestamp indicating when the feature group was last updated.
', 'DescribeFeatureMetadataResponse$LastModifiedTime' => '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
', 'DescribeInferenceRecommendationsJobResponse$LastModifiedTime' => 'A timestamp that shows when the job was last modified.
', 'DescribeNotebookInstanceLifecycleConfigOutput$LastModifiedTime' => 'A timestamp that tells when the lifecycle configuration was last modified.
', 'DescribeNotebookInstanceOutput$LastModifiedTime' => 'A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
', 'DescribeSpaceResponse$LastModifiedTime' => 'The last modified time.
', 'DescribeUserProfileResponse$LastModifiedTime' => 'The last modified time.
', 'DomainDetails$LastModifiedTime' => 'The last modified time.
', 'FeatureGroup$LastModifiedTime' => 'A timestamp indicating the last time you updated the feature group.
', 'FeatureMetadata$LastModifiedTime' => 'A timestamp indicating when the feature was last modified.
', 'InferenceRecommendationsJob$LastModifiedTime' => 'A timestamp that shows when the job was last modified.
', 'ListCompilationJobsRequest$LastModifiedTimeAfter' => 'A filter that returns the model compilation jobs that were modified after a specified time.
', 'ListCompilationJobsRequest$LastModifiedTimeBefore' => 'A filter that returns the model compilation jobs that were modified before a specified time.
', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only jobs that were last modified after the specified time (timestamp).
', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only jobs that were last modified before the specified time (timestamp).
', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeBefore' => 'A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeAfter' => 'A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
', 'ListNotebookInstancesInput$LastModifiedTimeBefore' => 'A filter that returns only notebook instances that were modified before the specified time (timestamp).
', 'ListNotebookInstancesInput$LastModifiedTimeAfter' => 'A filter that returns only notebook instances that were modified after the specified time (timestamp).
', 'NotebookInstanceLifecycleConfigSummary$LastModifiedTime' => 'A timestamp that tells when the lifecycle configuration was last modified.
', 'NotebookInstanceSummary$LastModifiedTime' => 'A timestamp that shows when the notebook instance was last modified.
', 'SpaceDetails$LastModifiedTime' => 'The last modified time.
', 'UserProfileDetails$LastModifiedTime' => 'The last modified time.
', ], ], 'LastUpdateStatus' => [ 'base' => 'A value that indicates whether the update was successful.
', 'refs' => [ 'DescribeFeatureGroupResponse$LastUpdateStatus' => 'A value indicating whether the update made to the feature group was successful.
', 'FeatureGroup$LastUpdateStatus' => 'A value that indicates whether the feature group was updated successfully.
', ], ], 'LastUpdateStatusValue' => [ 'base' => NULL, 'refs' => [ 'LastUpdateStatus$Status' => 'A value that indicates whether the update was made successful.
', ], ], 'LifecycleConfigArns' => [ 'base' => NULL, 'refs' => [ 'JupyterServerAppSettings$LifecycleConfigArns' => ' 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.
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.
A list of properties to add to the action.
', 'CreateArtifactRequest$Properties' => 'A list of properties to add to the artifact.
', 'CreateContextRequest$Properties' => 'A list of properties to add to the context.
', 'DescribeActionResponse$Properties' => 'A list of the action\'s properties.
', 'DescribeArtifactResponse$Properties' => 'A list of the artifact\'s properties.
', 'DescribeContextResponse$Properties' => 'A list of the context\'s properties.
', 'UpdateActionRequest$Properties' => 'The new list of properties. Overwrites the current property list.
', 'UpdateArtifactRequest$Properties' => 'The new list of properties. Overwrites the current property list.
', 'UpdateContextRequest$Properties' => 'The new list of properties. Overwrites the current property list.
', ], ], 'LineageGroupArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'DescribeArtifactResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'DescribeContextResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'DescribeLineageGroupResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'DescribeTrialComponentResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'GetLineageGroupPolicyResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'LineageGroupSummary$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group resource.
', 'TrialComponent$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group resource.
', ], ], 'LineageGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyRequest$LineageGroupName' => 'The name or Amazon Resource Name (ARN) of the lineage group.
', ], ], 'LineageGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsResponse$LineageGroupSummaries' => 'A list of lineage groups and their properties.
', ], ], 'LineageGroupSummary' => [ 'base' => 'Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.
', 'refs' => [ 'LineageGroupSummaries$member' => NULL, ], ], 'LineageType' => [ 'base' => NULL, 'refs' => [ 'QueryLineageTypes$member' => NULL, 'Vertex$LineageType' => 'The type of resource of the lineage entity.
', ], ], 'ListActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsRequest$SortBy' => 'The field by which to sort results. The default is CreationTime.
The column to sort by.
', ], ], 'ListDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansRequest$SortBy' => 'The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.
Use to specify what column to sort by.
', ], ], 'ListEndpointConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsRequest$SortBy' => 'The parameter by which to sort the results.
', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$SortBy' => 'The field to sort results by. The default is CreationTime.
A list of properties to remove.
', 'UpdateArtifactRequest$PropertiesToRemove' => 'A list of properties to remove.
', 'UpdateContextRequest$PropertiesToRemove' => 'A list of properties to remove.
', ], ], 'ListLineageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$MaxResults' => 'The maximum number of results to select.
', 'ListDevicesRequest$MaxResults' => 'Maximum number of results to select.
', 'ListEdgeDeploymentPlansRequest$MaxResults' => 'The maximum number of results to select (50 by default).
', 'ListEdgePackagingJobsRequest$MaxResults' => 'Maximum number of results to select.
', 'ListStageDevicesRequest$MaxResults' => 'The maximum number of requests to select.
', ], ], 'ListModelBiasJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelBiasJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListTagsInput$MaxResults' => 'Maximum number of tags to return.
', ], ], 'ListTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'UpdateTrialComponentRequest$ParametersToRemove' => 'The hyperparameters to remove from the component.
', 'UpdateTrialComponentRequest$InputArtifactsToRemove' => 'The input artifacts to remove from the component.
', 'UpdateTrialComponentRequest$OutputArtifactsToRemove' => 'The output artifacts to remove from the component.
', ], ], 'ListTrialComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesRequest$SortBy' => 'Sort workforces using the workforce name or creation date.
', ], ], 'ListWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsRequest$SortBy' => 'The field to sort results by. The default is CreationTime.
The number of Edge Manager agents.
', 'DeviceStats$ConnectedDeviceCount' => 'The number of devices connected with a heartbeat.
', 'DeviceStats$RegisteredDeviceCount' => 'The number of registered devices.
', 'EdgeModelStat$OfflineDeviceCount' => 'The number of devices that have this model version and do not have a heart beat.
', 'EdgeModelStat$ConnectedDeviceCount' => 'The number of devices that have this model version and have a heart beat.
', 'EdgeModelStat$ActiveDeviceCount' => 'The number of devices that have this model version, a heart beat, and are currently running.
', 'EdgeModelStat$SamplingDeviceCount' => 'The number of devices with this model version and are producing sample data.
', ], ], 'MLFramework' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$MLFramework' => 'The machine learning framework vended in the image version.
', 'DescribeImageVersionResponse$MLFramework' => 'The machine learning framework vended in the image version.
', 'UpdateImageVersionRequest$MLFramework' => 'The machine learning framework vended in the image version.
', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxAutoMLJobRuntimeInSeconds' => '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.
', ], ], 'MaxCandidates' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxCandidates' => 'The maximum number of times a training job is allowed to run.
For text and image classification, as well as time-series forecasting problem types, the supported value is 1. For tabular problem types, the maximum value is 750.
', ], ], 'MaxConcurrentInvocationsPerInstance' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceClientConfig$MaxConcurrentInvocationsPerInstance' => '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.
', ], ], 'MaxConcurrentTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$MaxConcurrentTaskCount' => '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.
', ], ], 'MaxConcurrentTransforms' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$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.
The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.
', 'TransformJob$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 number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
', ], ], 'MaxHumanLabeledObjectCount' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxHumanLabeledObjectCount' => 'The maximum number of objects that can be labeled by human workers.
', ], ], 'MaxNumberOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxNumberOfTests' => 'Defines the maximum number of load tests.
', ], ], 'MaxNumberOfTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxNumberOfTrainingJobs' => 'The maximum number of training jobs that a hyperparameter tuning job can launch.
', ], ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'base' => NULL, 'refs' => [ 'BestObjectiveNotImproving$MaxNumberOfTrainingJobsNotImproving' => '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.
', ], ], 'MaxParallelExecutionSteps' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$MaxParallelExecutionSteps' => 'The max number of steps that can be executed in parallel.
', ], ], 'MaxParallelOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxParallelOfTests' => 'Defines the maximum number of parallel load tests.
', ], ], 'MaxParallelTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxParallelTrainingJobs' => 'The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
', ], ], 'MaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxPayloadInMB' => '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.
The maximum payload size, in MB, used in the transform job.
', 'TransformJob$MaxPayloadInMB' => '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.
The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
', ], ], 'MaxPercentageOfInputDatasetLabeled' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxPercentageOfInputDatasetLabeled' => 'The maximum number of input data objects that should be labeled.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$MaxResults' => 'The maximum number of actions to return in the response. The default value is 10.
', 'ListAlgorithmsInput$MaxResults' => 'The maximum number of algorithms to return in the response.
', 'ListAliasesRequest$MaxResults' => 'The maximum number of aliases to return.
', 'ListAppImageConfigsRequest$MaxResults' => '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.
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.
The maximum number of artifacts to return in the response. The default value is 10.
', 'ListAssociationsRequest$MaxResults' => 'The maximum number of associations to return in the response. The default value is 10.
', 'ListCodeRepositoriesInput$MaxResults' => 'The maximum number of Git repositories to return in the response.
', 'ListCompilationJobsRequest$MaxResults' => 'The maximum number of model compilation jobs to return in the response.
', 'ListContextsRequest$MaxResults' => 'The maximum number of contexts to return in the response. The default value is 10.
', 'ListDataQualityJobDefinitionsRequest$MaxResults' => 'The maximum number of data quality monitoring job definitions to return in the response.
', 'ListDomainsRequest$MaxResults' => '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.
The maximum number of training jobs to return in the response.
', 'ListEndpointsInput$MaxResults' => 'The maximum number of endpoints to return in the response. This value defaults to 10.
', 'ListExperimentsRequest$MaxResults' => 'The maximum number of experiments to return in the response. The default value is 10.
', 'ListFlowDefinitionsRequest$MaxResults' => 'The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The maximum number of hub content versions to list.
', 'ListHubContentsRequest$MaxResults' => 'The maximum amount of hub content to list.
', 'ListHubsRequest$MaxResults' => 'The maximum number of hubs to list.
', 'ListHumanTaskUisRequest$MaxResults' => 'The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The maximum number of tuning jobs to return. The default value is 10.
', 'ListImageVersionsRequest$MaxResults' => 'The maximum number of versions to return in the response. The default value is 10.
', 'ListImagesRequest$MaxResults' => 'The maximum number of images to return in the response. The default value is 10.
', 'ListInferenceExperimentsRequest$MaxResults' => 'The maximum number of results to select.
', 'ListInferenceRecommendationsJobStepsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListInferenceRecommendationsJobsRequest$MaxResults' => 'The maximum number of recommendations to return in the response.
', 'ListLabelingJobsForWorkteamRequest$MaxResults' => 'The maximum number of labeling jobs to return in each page of the response.
', 'ListLabelingJobsRequest$MaxResults' => 'The maximum number of labeling jobs to return in each page of the response.
', 'ListLineageGroupsRequest$MaxResults' => 'The maximum number of endpoints to return in the response. This value defaults to 10.
', 'ListModelBiasJobDefinitionsRequest$MaxResults' => 'The maximum number of model bias jobs to return in the response. The default value is 10.
', 'ListModelCardExportJobsRequest$MaxResults' => 'The maximum number of model card export jobs to list.
', 'ListModelCardVersionsRequest$MaxResults' => 'The maximum number of model card versions to list.
', 'ListModelCardsRequest$MaxResults' => 'The maximum number of model cards to list.
', 'ListModelExplainabilityJobDefinitionsRequest$MaxResults' => 'The maximum number of jobs to return in the response. The default value is 10.
', 'ListModelMetadataRequest$MaxResults' => 'The maximum number of models to return in the response.
', 'ListModelPackageGroupsInput$MaxResults' => 'The maximum number of results to return in the response.
', 'ListModelPackagesInput$MaxResults' => 'The maximum number of model packages to return in the response.
', 'ListModelQualityJobDefinitionsRequest$MaxResults' => 'The maximum number of results to return in a call to ListModelQualityJobDefinitions.
The maximum number of models to return in the response.
', 'ListMonitoringAlertHistoryRequest$MaxResults' => 'The maximum number of results to display. The default is 100.
', 'ListMonitoringAlertsRequest$MaxResults' => 'The maximum number of results to display. The default is 100.
', 'ListMonitoringExecutionsRequest$MaxResults' => 'The maximum number of jobs to return in the response. The default value is 10.
', 'ListMonitoringSchedulesRequest$MaxResults' => 'The maximum number of jobs to return in the response. The default value is 10.
', 'ListNotebookInstanceLifecycleConfigsInput$MaxResults' => 'The maximum number of lifecycle configurations to return in the response.
', 'ListNotebookInstancesInput$MaxResults' => 'The maximum number of notebook instances to return.
', 'ListPipelineExecutionStepsRequest$MaxResults' => 'The maximum number of pipeline execution steps to return in the response.
', 'ListPipelineExecutionsRequest$MaxResults' => 'The maximum number of pipeline executions to return in the response.
', 'ListPipelineParametersForExecutionRequest$MaxResults' => 'The maximum number of parameters to return in the response.
', 'ListPipelinesRequest$MaxResults' => 'The maximum number of pipelines to return in the response.
', 'ListProcessingJobsRequest$MaxResults' => 'The maximum number of processing jobs to return in the response.
', 'ListProjectsInput$MaxResults' => 'The maximum number of projects to return in the response.
', 'ListResourceCatalogsRequest$MaxResults' => ' The maximum number of results returned by ListResourceCatalogs.
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.
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.
The maximum number of work teams to return in each page of the response.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$MaxResults' => 'The maximum number of training jobs to return. The default value is 10.
', 'ListTrainingJobsRequest$MaxResults' => 'The maximum number of training jobs to return in the response.
', 'ListTransformJobsRequest$MaxResults' => 'The maximum number of transform jobs to return in the response. The default value is 10.
The maximum number of components to return in the response. The default value is 10.
', 'ListTrialsRequest$MaxResults' => 'The maximum number of trials to return in the response. The default value is 10.
', 'ListUserProfilesRequest$MaxResults' => '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.
The maximum number of workforces returned in the response.
', 'ListWorkteamsRequest$MaxResults' => 'The maximum number of work teams to return in each page of the response.
', 'SearchRequest$MaxResults' => 'The maximum number of results to return.
', ], ], 'MaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxRuntimeInSeconds' => '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 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.
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.
Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.
The time limit for the total deployment. Exceeding this limit causes a timeout.
', ], ], 'MaximumRetryAttempts' => [ 'base' => NULL, 'refs' => [ 'RetryStrategy$MaximumRetryAttempts' => 'The number of times to retry the job. When the job is retried, it\'s SecondaryStatus is changed to STARTING.
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.
', ], ], 'MemberDefinition' => [ 'base' => 'Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
', 'refs' => [ 'MemberDefinitions$member' => NULL, ], ], 'MemberDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$MemberDefinitions' => '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.
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.
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.
Metadata properties of the tracking entity, trial, or trial component.
', 'refs' => [ 'CreateActionRequest$MetadataProperties' => NULL, 'CreateArtifactRequest$MetadataProperties' => NULL, 'CreateModelPackageInput$MetadataProperties' => NULL, 'CreateTrialComponentRequest$MetadataProperties' => NULL, 'CreateTrialRequest$MetadataProperties' => NULL, 'DescribeActionResponse$MetadataProperties' => NULL, 'DescribeArtifactResponse$MetadataProperties' => NULL, 'DescribeModelPackageOutput$MetadataProperties' => NULL, 'DescribeTrialComponentResponse$MetadataProperties' => NULL, 'DescribeTrialResponse$MetadataProperties' => NULL, 'ModelPackage$MetadataProperties' => 'Metadata properties of the tracking entity, trial, or trial component.
', 'Trial$MetadataProperties' => NULL, 'TrialComponent$MetadataProperties' => NULL, ], ], 'MetadataPropertyValue' => [ 'base' => NULL, 'refs' => [ 'MetadataProperties$CommitId' => 'The commit ID.
', 'MetadataProperties$Repository' => 'The repository.
', 'MetadataProperties$GeneratedBy' => 'The entity this entity was generated by.
', 'MetadataProperties$ProjectId' => 'The project ID.
', ], ], 'MetricData' => [ 'base' => 'The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
', 'refs' => [ 'FinalMetricDataList$member' => NULL, ], ], 'MetricDataList' => [ 'base' => NULL, 'refs' => [ 'CandidateProperties$CandidateMetrics' => 'Information about the candidate metrics for an AutoML job.
', ], ], 'MetricDatum' => [ 'base' => 'Information about the metric for a candidate produced by an AutoML job.
', 'refs' => [ 'MetricDataList$member' => NULL, ], ], 'MetricDefinition' => [ 'base' => '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.
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.
', 'HyperParameterAlgorithmSpecification$MetricDefinitions' => 'An array of MetricDefinition objects that specify the metrics that the algorithm emits.
', 'TrainingSpecification$MetricDefinitions' => 'A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.
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.
', 'HyperParameterTuningJobObjective$MetricName' => 'The name of the metric to use for the objective metric.
', 'MetricData$MetricName' => 'The name of the metric.
', 'MetricDefinition$Name' => 'The name of the metric.
', 'TrialComponentMetricSummary$MetricName' => 'The name of the metric.
', ], ], 'MetricRegex' => [ 'base' => NULL, 'refs' => [ 'MetricDefinition$Regex' => '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.
', ], ], 'MetricSetSource' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$Set' => 'The dataset split from which the AutoML job produced the metric.
', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Value' => 'The value of the metric with the best result.
', 'FinalHyperParameterTuningJobObjectiveMetric$Value' => 'The value of the objective metric.
', ], ], 'MetricsSource' => [ 'base' => 'Details about the metrics source.
', 'refs' => [ 'Bias$Report' => 'The bias report for a model
', 'Bias$PreTrainingReport' => 'The pre-training bias report for a model.
', 'Bias$PostTrainingReport' => 'The post-training bias report for a model.
', 'DriftCheckBias$PreTrainingConstraints' => 'The pre-training constraints.
', 'DriftCheckBias$PostTrainingConstraints' => 'The post-training constraints.
', 'DriftCheckExplainability$Constraints' => 'The drift check explainability constraints.
', 'DriftCheckModelDataQuality$Statistics' => 'The drift check model data quality statistics.
', 'DriftCheckModelDataQuality$Constraints' => 'The drift check model data quality constraints.
', 'DriftCheckModelQuality$Statistics' => 'The drift check model quality statistics.
', 'DriftCheckModelQuality$Constraints' => 'The drift check model quality constraints.
', 'Explainability$Report' => 'The explainability report for a model.
', 'ModelDataQuality$Statistics' => 'Data quality statistics for a model.
', 'ModelDataQuality$Constraints' => 'Data quality constraints for a model.
', 'ModelQuality$Statistics' => 'Model quality statistics.
', 'ModelQuality$Constraints' => 'Model quality constraints.
', ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataServiceConfiguration$MinimumInstanceMetadataServiceVersion' => '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 properties of a model as returned by the Search API.
', 'refs' => [ 'ModelDashboardModel$Model' => 'A model displayed in the Model Dashboard.
', ], ], 'ModelApprovalStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelApprovalStatus' => 'The approval status of the model.
', 'CreateModelPackageInput$ModelApprovalStatus' => '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 approval status of the model package.
', 'ListModelPackagesInput$ModelApprovalStatus' => 'A filter that returns only the model packages with the specified approval status.
', 'ModelPackage$ModelApprovalStatus' => '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 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 approval status of the model.
', ], ], 'ModelArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelOutput$ModelArn' => 'The ARN of the model created in SageMaker.
', 'DescribeModelOutput$ModelArn' => 'The Amazon Resource Name (ARN) of the model.
', 'LabelingJobAlgorithmsConfig$InitialActiveLearningModelArn' => '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.
', 'LabelingJobOutput$FinalActiveLearningModelArn' => 'The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.
', 'Model$ModelArn' => 'The Amazon Resource Name (ARN) of the model.
', 'ModelSummary$ModelArn' => 'The Amazon Resource Name (ARN) of the model.
', ], ], 'ModelArtifacts' => [ 'base' => 'Provides information about the location that is configured for storing model artifacts.
Model artifacts are the output that results from training a model, and typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata.
', 'refs' => [ 'DescribeCompilationJobResponse$ModelArtifacts' => 'Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
', 'DescribeTrainingJobResponse$ModelArtifacts' => 'Information about the Amazon S3 location that is configured for storing model artifacts.
', 'TrainingJob$ModelArtifacts' => 'Information about the Amazon S3 location that is configured for storing model artifacts.
', ], ], 'ModelBiasAppSpecification' => [ 'base' => 'Docker container image configuration object for the model bias job.
', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasAppSpecification' => 'Configures the model bias job to run a specified Docker container image.
', 'DescribeModelBiasJobDefinitionResponse$ModelBiasAppSpecification' => 'Configures the model bias job to run a specified Docker container image.
', ], ], 'ModelBiasBaselineConfig' => [ 'base' => 'The configuration for a baseline model bias job.
', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasBaselineConfig' => 'The baseline configuration for a model bias job.
', 'DescribeModelBiasJobDefinitionResponse$ModelBiasBaselineConfig' => 'The baseline configuration for a model bias job.
', ], ], 'ModelBiasJobInput' => [ 'base' => 'Inputs for the model bias job.
', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasJobInput' => 'Inputs for the model bias job.
', 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobInput' => 'Inputs for the model bias job.
', ], ], 'ModelCacheSetting' => [ 'base' => NULL, 'refs' => [ 'MultiModelConfig$ModelCacheSetting' => '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.
An Amazon SageMaker Model Card.
', 'refs' => [ 'SearchRecord$ModelCard' => 'An Amazon SageMaker Model Card that documents details about a machine learning model.
', ], ], 'ModelCardArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardResponse$ModelCardArn' => 'The Amazon Resource Name (ARN) of the successfully created model card.
', 'DescribeModelCardResponse$ModelCardArn' => 'The Amazon Resource Name (ARN) of the model card.
', 'ModelCard$ModelCardArn' => 'The Amazon Resource Name (ARN) of the model card.
', 'ModelCardSummary$ModelCardArn' => 'The Amazon Resource Name (ARN) of the model card.
', 'ModelCardVersionSummary$ModelCardArn' => 'The Amazon Resource Name (ARN) of the model card.
', 'ModelDashboardModelCard$ModelCardArn' => 'The Amazon Resource Name (ARN) for a model card.
', 'UpdateModelCardResponse$ModelCardArn' => 'The Amazon Resource Name (ARN) of the updated model card.
', ], ], 'ModelCardContent' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$Content' => 'The content of the model card. Content must be in model card JSON schema and provided as a string.
', 'DescribeModelCardResponse$Content' => 'The content of the model card.
', 'ModelCard$Content' => 'The content of the model card. Content uses the model card JSON schema and provided as a string.
', 'UpdateModelCardRequest$Content' => '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.
', ], ], 'ModelCardExportArtifacts' => [ 'base' => 'The artifacts of the model card export job.
', 'refs' => [ 'DescribeModelCardExportJobResponse$ExportArtifacts' => 'The exported model card artifacts.
', ], ], 'ModelCardExportJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobResponse$ModelCardExportJobArn' => 'The Amazon Resource Name (ARN) of the model card export job.
', 'DescribeModelCardExportJobRequest$ModelCardExportJobArn' => 'The Amazon Resource Name (ARN) of the model card export job to describe.
', 'DescribeModelCardExportJobResponse$ModelCardExportJobArn' => 'The Amazon Resource Name (ARN) of the model card export job.
', 'ModelCardExportJobSummary$ModelCardExportJobArn' => 'The Amazon Resource Name (ARN) of the model card export job.
', ], ], 'ModelCardExportJobSortBy' => [ 'base' => 'Attribute by which to sort returned export jobs.', 'refs' => [ 'ListModelCardExportJobsRequest$SortBy' => 'Sort model card export jobs by either name or creation time. Sorts by creation time by default.
', ], ], 'ModelCardExportJobSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsRequest$SortOrder' => 'Sort model card export jobs by ascending or descending order.
', ], ], 'ModelCardExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardExportJobResponse$Status' => '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.
Only list model card export jobs with the specified status.
', 'ModelCardExportJobSummary$Status' => 'The completion status of the model card export job.
', ], ], 'ModelCardExportJobSummary' => [ 'base' => 'The summary of the Amazon SageMaker Model Card export job.
', 'refs' => [ 'ModelCardExportJobSummaryList$member' => NULL, ], ], 'ModelCardExportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsResponse$ModelCardExportJobSummaries' => 'The summaries of the listed model card export jobs.
', ], ], 'ModelCardExportOutputConfig' => [ 'base' => 'Configure the export output details for an Amazon SageMaker Model Card.
', 'refs' => [ 'CreateModelCardExportJobRequest$OutputConfig' => 'The model card output configuration that specifies the Amazon S3 path for exporting.
', 'DescribeModelCardExportJobResponse$OutputConfig' => 'The export output details for the model card.
', ], ], 'ModelCardProcessingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardResponse$ModelCardProcessingStatus' => '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.
Configure the security settings to protect model card data.
', 'refs' => [ 'CreateModelCardRequest$SecurityConfig' => 'An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
', 'DescribeModelCardResponse$SecurityConfig' => 'The security configuration used to protect model card content.
', 'ModelCard$SecurityConfig' => 'The security configuration used to protect model card data.
', 'ModelDashboardModelCard$SecurityConfig' => 'The KMS Key ID (KMSKeyId) for encryption of model card information.
Sort model cards by either name or creation time. Sorts by creation time by default.
', ], ], 'ModelCardSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortOrder' => 'Sort model card versions by ascending or descending order.
', 'ListModelCardsRequest$SortOrder' => 'Sort model cards by ascending or descending order.
', ], ], 'ModelCardStatus' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$ModelCardStatus' => '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 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.
Only list model card versions with the specified approval status.
', 'ListModelCardsRequest$ModelCardStatus' => 'Only list model cards with the specified approval status.
', 'ModelCard$ModelCardStatus' => '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 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.
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 card status.
', 'UpdateModelCardRequest$ModelCardStatus' => '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.
A summary of the model card.
', 'refs' => [ 'ModelCardSummaryList$member' => NULL, ], ], 'ModelCardSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsResponse$ModelCardSummaries' => 'The summaries of the listed model cards.
', ], ], 'ModelCardVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortBy' => 'Sort listed model card versions by version. Sorts by version by default.
', ], ], 'ModelCardVersionSummary' => [ 'base' => 'A summary of a specific version of the model card.
', 'refs' => [ 'ModelCardVersionSummaryList$member' => NULL, ], ], 'ModelCardVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsResponse$ModelCardVersionSummaryList' => 'The summaries of the listed versions of the model card.
', ], ], 'ModelClientConfig' => [ 'base' => 'Configures the timeout and maximum number of retries for processing a transform job invocation.
', 'refs' => [ 'CreateTransformJobRequest$ModelClientConfig' => 'Configures the timeout and maximum number of retries for processing a transform job invocation.
', 'DescribeTransformJobResponse$ModelClientConfig' => 'The timeout and maximum number of retries for processing a transform job invocation.
', 'TransformJob$ModelClientConfig' => NULL, ], ], 'ModelCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$CompressionType' => 'Specifies 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.
Defines the model configuration. Includes the specification name and environment parameters.
', 'refs' => [ 'InferenceRecommendation$ModelConfiguration' => 'Defines the model configuration.
', 'RecommendationJobInferenceBenchmark$ModelConfiguration' => NULL, ], ], 'ModelDashboardEndpoint' => [ 'base' => 'An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.
', 'refs' => [ 'ModelDashboardEndpoints$member' => NULL, ], ], 'ModelDashboardEndpoints' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$Endpoints' => 'The endpoints that host a model.
', ], ], 'ModelDashboardIndicatorAction' => [ 'base' => 'An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.
An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.
A model displayed in the Amazon SageMaker Model Dashboard.
', 'refs' => [ 'SearchRecord$Model' => NULL, ], ], 'ModelDashboardModelCard' => [ 'base' => 'The model card for a model displayed in the Amazon SageMaker Model Dashboard.
', 'refs' => [ 'ModelDashboardModel$ModelCard' => 'The model card for a model.
', ], ], 'ModelDashboardMonitoringSchedule' => [ 'base' => 'A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.
', 'refs' => [ 'ModelDashboardMonitoringSchedules$member' => NULL, ], ], 'ModelDashboardMonitoringSchedules' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$MonitoringSchedules' => 'The monitoring schedules for a model.
', ], ], 'ModelDataQuality' => [ 'base' => 'Data quality constraints and statistics for a model.
', 'refs' => [ 'ModelMetrics$ModelDataQuality' => 'Metrics that measure the quality of the input data for a model.
', ], ], 'ModelDataSource' => [ 'base' => 'Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.
', 'refs' => [ 'ContainerDefinition$ModelDataSource' => '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.
Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
', 'refs' => [ 'CreateAutoMLJobRequest$ModelDeployConfig' => 'Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
', 'CreateAutoMLJobV2Request$ModelDeployConfig' => 'Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
', 'DescribeAutoMLJobResponse$ModelDeployConfig' => 'Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
', 'DescribeAutoMLJobV2Response$ModelDeployConfig' => 'Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
', ], ], 'ModelDeployResult' => [ 'base' => 'Provides information about the endpoint of the model deployment.
', 'refs' => [ 'DescribeAutoMLJobResponse$ModelDeployResult' => 'Provides information about endpoint for the model deployment.
', 'DescribeAutoMLJobV2Response$ModelDeployResult' => 'Provides information about endpoint for the model deployment.
', ], ], 'ModelDigests' => [ 'base' => 'Provides information to verify the integrity of stored model artifacts.
', 'refs' => [ 'DescribeCompilationJobResponse$ModelDigests' => 'Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
', ], ], 'ModelExplainabilityAppSpecification' => [ 'base' => 'Docker container image configuration object for the model explainability job.
', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityAppSpecification' => 'Configures the model explainability job to run a specified Docker container image.
', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityAppSpecification' => 'Configures the model explainability job to run a specified Docker container image.
', ], ], 'ModelExplainabilityBaselineConfig' => [ 'base' => 'The configuration for a baseline model explainability job.
', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityBaselineConfig' => 'The baseline configuration for a model explainability job.
', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityBaselineConfig' => 'The baseline configuration for a model explainability job.
', ], ], 'ModelExplainabilityJobInput' => [ 'base' => 'Inputs for the model explainability job.
', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobInput' => 'Inputs for the model explainability job.
', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobInput' => 'Inputs for the model explainability job.
', ], ], 'ModelInfrastructureConfig' => [ 'base' => 'The configuration for the infrastructure that the model will be deployed to.
', 'refs' => [ 'ModelVariantConfig$InfrastructureConfig' => 'The configuration for the infrastructure that the model will be deployed to.
', 'ModelVariantConfigSummary$InfrastructureConfig' => 'The configuration of the infrastructure that the model has been deployed to.
', ], ], 'ModelInfrastructureType' => [ 'base' => NULL, 'refs' => [ 'ModelInfrastructureConfig$InfrastructureType' => 'The inference option to which to deploy your model. Possible values are the following:
RealTime: Deploy to real-time inference.
Input object for the model.
', 'refs' => [ 'ModelPackageContainerDefinition$ModelInput' => 'A structure with Model Input details.
', ], ], 'ModelInsightsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$ModelInsights' => 'The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.
', ], ], 'ModelLatencyThreshold' => [ 'base' => 'The model latency threshold.
', 'refs' => [ 'ModelLatencyThresholds$member' => NULL, ], ], 'ModelLatencyThresholds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$ModelLatencyThresholds' => '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.
', ], ], 'ModelMetadataFilter' => [ 'base' => 'Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).
', 'refs' => [ 'ModelMetadataFilters$member' => NULL, ], ], 'ModelMetadataFilterType' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataFilter$Name' => 'The name of the of the model to filter by.
', ], ], 'ModelMetadataFilters' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataSearchExpression$Filters' => 'A list of filter objects.
', ], ], 'ModelMetadataSearchExpression' => [ 'base' => '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
', 'refs' => [ 'ListModelMetadataRequest$SearchExpression' => '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.
', ], ], 'ModelMetadataSummaries' => [ 'base' => NULL, 'refs' => [ 'ListModelMetadataResponse$ModelMetadataSummaries' => 'A structure that holds model metadata.
', ], ], 'ModelMetadataSummary' => [ 'base' => 'A summary of the model metadata.
', 'refs' => [ 'ModelMetadataSummaries$member' => NULL, ], ], 'ModelMetrics' => [ 'base' => 'Contains metrics captured from a model.
', 'refs' => [ 'CreateModelPackageInput$ModelMetrics' => 'A structure that contains model metrics reports.
', 'DescribeModelPackageOutput$ModelMetrics' => 'Metrics for the model.
', 'ModelPackage$ModelMetrics' => 'Metrics for the model.
', ], ], 'ModelName' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$ModelName' => 'The name of the new model.
', 'CreateTransformJobRequest$ModelName' => '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 name of the model to delete.
', 'DescribeModelInput$ModelName' => 'The name of the model.
', 'DescribeModelOutput$ModelName' => 'Name of the SageMaker model.
', 'DescribeTransformJobResponse$ModelName' => 'The name of the model used in the transform job.
', 'InferenceRecommendationsJob$ModelName' => 'The name of the created model.
', 'ListInferenceRecommendationsJobsRequest$ModelNameEquals' => 'A filter that returns only jobs that were created for this model.
', 'Model$ModelName' => 'The name of the model.
', 'ModelSummary$ModelName' => 'The name of the model that you want a summary for.
', 'ModelVariantConfig$ModelName' => 'The name of the Amazon SageMaker Model entity.
', 'ModelVariantConfigSummary$ModelName' => 'The name of the Amazon SageMaker Model entity.
', 'ProductionVariant$ModelName' => 'The name of the model that you want to host. This is the name that you specified when creating the model.
', 'RecommendationJobInputConfig$ModelName' => 'The name of the created model.
', 'TransformJob$ModelName' => 'The name of the model associated with the transform job.
', ], ], 'ModelNameContains' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$NameContains' => 'A string in the model name. This filter returns only models whose name contains the specified string.
', ], ], 'ModelPackage' => [ 'base' => 'A versioned model that can be deployed for SageMaker inference.
', 'refs' => [ 'SearchRecord$ModelPackage' => NULL, ], ], 'ModelPackageArn' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageErrorMap$key' => NULL, 'BatchDescribeModelPackageSummary$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'CreateCompilationJobRequest$ModelPackageVersionArn' => '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.
The Amazon Resource Name (ARN) of the new model package.
', 'DescribeCompilationJobResponse$ModelPackageVersionArn' => 'The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.
', 'DescribeModelPackageOutput$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'InferenceRecommendationsJob$ModelPackageVersionArn' => 'The Amazon Resource Name (ARN) of a versioned model package.
', 'ListInferenceRecommendationsJobsRequest$ModelPackageVersionArnEquals' => 'A filter that returns only jobs that were created for this versioned model package.
', 'ModelPackage$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'ModelPackageArnList$member' => NULL, 'ModelPackageSummaries$key' => NULL, 'ModelPackageSummary$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'RecommendationJobInputConfig$ModelPackageVersionArn' => 'The Amazon Resource Name (ARN) of a versioned model package.
', 'UpdateModelPackageInput$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'UpdateModelPackageOutput$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model.
', ], ], 'ModelPackageArnList' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageInput$ModelPackageArnList' => 'The list of Amazon Resource Name (ARN) of the model package groups.
', ], ], 'ModelPackageContainerDefinition' => [ 'base' => 'Describes the Docker container for the model package.
', 'refs' => [ 'ModelPackageContainerDefinitionList$member' => NULL, ], ], 'ModelPackageContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Containers' => 'The Amazon ECR registry path of the Docker image that contains the inference code.
', 'InferenceSpecification$Containers' => 'The Amazon ECR registry path of the Docker image that contains the inference code.
', ], ], 'ModelPackageFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$FrameworkVersion' => 'The framework version of the Model Package Container Image.
', ], ], 'ModelPackageGroup' => [ 'base' => 'A group of versioned models in the model registry.
', 'refs' => [ 'SearchRecord$ModelPackageGroup' => NULL, ], ], 'ModelPackageGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageGroupOutput$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model group.
', 'DescribeModelPackageGroupOutput$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model group.
', 'ModelPackageGroup$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model group.
', 'ModelPackageGroupSummary$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model group.
', 'PutModelPackageGroupPolicyOutput$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model package group.
', ], ], 'ModelPackageGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsInput$SortBy' => 'The field to sort results by. The default is CreationTime.
The status of the model group.
', 'ModelPackageGroup$ModelPackageGroupStatus' => '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.
The status of the model group.
', ], ], 'ModelPackageGroupSummary' => [ 'base' => 'Summary information about a model group.
', 'refs' => [ 'ModelPackageGroupSummaryList$member' => NULL, ], ], 'ModelPackageGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsOutput$ModelPackageGroupSummaryList' => 'A list of summaries of the model groups in your Amazon Web Services account.
', ], ], 'ModelPackageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
The status of the mortgage package.
', 'DescribeModelPackageOutput$ModelPackageStatus' => 'The current status of the model package.
', 'ModelPackage$ModelPackageStatus' => '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.
The overall status of the model package.
', ], ], 'ModelPackageStatusDetails' => [ 'base' => 'Specifies the validation and image scan statuses of the model package.
', 'refs' => [ 'DescribeModelPackageOutput$ModelPackageStatusDetails' => 'Details about the current status of the model package.
', 'ModelPackage$ModelPackageStatusDetails' => 'Specifies the validation and image scan statuses of the model package.
', ], ], 'ModelPackageStatusItem' => [ 'base' => 'Represents the overall status of a model package.
', 'refs' => [ 'ModelPackageStatusItemList$member' => NULL, ], ], 'ModelPackageStatusItemList' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusDetails$ValidationStatuses' => 'The validation status of the model package.
', 'ModelPackageStatusDetails$ImageScanStatuses' => 'The status of the scan of the Docker image container for the model package.
', ], ], 'ModelPackageSummaries' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$ModelPackageSummaries' => 'The summaries for the model package versions
', ], ], 'ModelPackageSummary' => [ 'base' => 'Provides summary information about a model package.
', 'refs' => [ 'ModelPackageSummaryList$member' => NULL, ], ], 'ModelPackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesOutput$ModelPackageSummaryList' => 'An array of ModelPackageSummary objects, each of which lists a model package.
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.
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.
', 'refs' => [ 'ModelPackageValidationProfiles$member' => NULL, ], ], 'ModelPackageValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'ModelPackageValidationSpecification$ValidationProfiles' => 'An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.
Specifies batch transform jobs that SageMaker runs to validate your model package.
', 'refs' => [ 'CreateModelPackageInput$ValidationSpecification' => 'Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.
', 'DescribeModelPackageOutput$ValidationSpecification' => 'Configurations for one or more transform jobs that SageMaker runs to test the model package.
', 'ModelPackage$ValidationSpecification' => 'Specifies batch transform jobs that SageMaker runs to validate your model package.
', ], ], 'ModelPackageVersion' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageVersion' => 'The version number of a versioned model.
', 'DescribeModelPackageOutput$ModelPackageVersion' => 'The version of the model package.
', 'ModelPackage$ModelPackageVersion' => 'The version number of a versioned model.
', 'ModelPackageSummary$ModelPackageVersion' => 'If the model package is a versioned model, the version of the model.
', ], ], 'ModelQuality' => [ 'base' => 'Model quality statistics and constraints.
', 'refs' => [ 'ModelMetrics$ModelQuality' => 'Metrics that measure the quality of a model.
', ], ], 'ModelQualityAppSpecification' => [ 'base' => 'Container image configuration object for the monitoring job.
', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityAppSpecification' => 'The container that runs the monitoring job.
', 'DescribeModelQualityJobDefinitionResponse$ModelQualityAppSpecification' => 'Configures the model quality job to run a specified Docker container image.
', ], ], 'ModelQualityBaselineConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityBaselineConfig' => 'Specifies the constraints and baselines for the monitoring job.
', 'DescribeModelQualityJobDefinitionResponse$ModelQualityBaselineConfig' => 'The baseline configuration for a model quality job.
', ], ], 'ModelQualityJobInput' => [ 'base' => 'The input for the model quality monitoring job. Currently endponts are supported for input for model quality monitoring jobs.
', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityJobInput' => 'A list of the inputs that are monitored. Currently endpoints are supported.
', 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobInput' => 'Inputs for the model quality job.
', ], ], 'ModelRegisterSettings' => [ 'base' => 'The model registry settings for the SageMaker Canvas application.
', 'refs' => [ 'CanvasAppSettings$ModelRegisterSettings' => 'The model registry settings for the SageMaker Canvas application.
', ], ], 'ModelSetupTime' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$ModelSetupTime' => '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.
Sorts the list of results. The default is CreationTime.
Metadata for Model steps.
', 'refs' => [ 'PipelineExecutionStepMetadata$Model' => 'The Amazon Resource Name (ARN) of the model that was created by this step execution.
', ], ], 'ModelSummary' => [ 'base' => 'Provides summary information about a model.
', 'refs' => [ 'ModelSummaryList$member' => NULL, ], ], 'ModelSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelsOutput$Models' => 'An array of ModelSummary objects, each of which lists a model.
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
Contains information about the deployment options of a model.
', 'refs' => [ 'ModelVariantConfigList$member' => NULL, ], ], 'ModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$ModelVariants' => ' 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.
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.
An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.
Summary of the deployment configuration of a model.
', 'refs' => [ 'ModelVariantConfigSummaryList$member' => NULL, ], ], 'ModelVariantConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$ModelVariants' => ' 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.
The name of the variant.
', 'ModelVariantConfigSummary$VariantName' => 'The name of the variant.
', 'ShadowModeConfig$SourceModelVariantName' => 'The name of the production variant, which takes all the inference requests.
', 'ShadowModelVariantConfig$ShadowModelVariantName' => 'The name of the shadow variant.
', ], ], 'ModelVariantStatus' => [ 'base' => NULL, 'refs' => [ 'ModelVariantConfigSummary$Status' => '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.
A list of alert actions taken in response to an alert going into InAlert status.
A list of alert actions taken in response to an alert going into InAlert status.
An alert history for a model monitoring schedule.
', ], ], 'MonitoringAlertHistorySortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$SortBy' => 'The field used to sort results. The default is CreationTime.
Provides summary information of an alert\'s history.
', 'refs' => [ 'MonitoringAlertHistoryList$member' => NULL, ], ], 'MonitoringAlertName' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$MonitoringAlertName' => 'The name of a monitoring alert.
', 'MonitoringAlertHistorySummary$MonitoringAlertName' => 'The name of a monitoring alert.
', 'MonitoringAlertSummary$MonitoringAlertName' => 'The name of a monitoring alert.
', 'UpdateMonitoringAlertRequest$MonitoringAlertName' => 'The name of a monitoring alert.
', 'UpdateMonitoringAlertResponse$MonitoringAlertName' => 'The name of a monitoring alert.
', ], ], 'MonitoringAlertStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$StatusEquals' => 'A filter that retrieves only alerts with a specific status.
', 'MonitoringAlertHistorySummary$AlertStatus' => 'The current alert status of an alert.
', 'MonitoringAlertSummary$AlertStatus' => 'The current status of an alert.
', ], ], 'MonitoringAlertSummary' => [ 'base' => 'Provides summary information about a monitor alert.
', 'refs' => [ 'MonitoringAlertSummaryList$member' => NULL, ], ], 'MonitoringAlertSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertsResponse$MonitoringAlertSummaries' => 'A JSON array where each element is a summary for a monitoring alert.
', 'ModelDashboardMonitoringSchedule$MonitoringAlertSummaries' => 'A JSON array where each element is a summary for a monitoring alert.
', ], ], 'MonitoringAppSpecification' => [ 'base' => 'Container image configuration object for the monitoring job.
', 'refs' => [ 'MonitoringJobDefinition$MonitoringAppSpecification' => 'Configures the monitoring job to run a specified Docker container image.
', ], ], 'MonitoringBaselineConfig' => [ 'base' => '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.
', 'refs' => [ 'MonitoringJobDefinition$BaselineConfig' => 'Baseline configuration used to validate that the data conforms to the specified constraints and statistics
', ], ], 'MonitoringClusterConfig' => [ 'base' => 'Configuration for the cluster used to run model monitoring jobs.
', 'refs' => [ 'MonitoringResources$ClusterConfig' => 'The configuration for the cluster resources used to run the processing job.
', ], ], 'MonitoringConstraintsResource' => [ 'base' => 'The constraints resource for a monitoring job.
', 'refs' => [ 'DataQualityBaselineConfig$ConstraintsResource' => NULL, 'ModelBiasBaselineConfig$ConstraintsResource' => NULL, 'ModelExplainabilityBaselineConfig$ConstraintsResource' => NULL, 'ModelQualityBaselineConfig$ConstraintsResource' => NULL, 'MonitoringBaselineConfig$ConstraintsResource' => 'The baseline constraint file in Amazon S3 that the current monitoring job should validated against.
', ], ], 'MonitoringContainerArguments' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$ContainerArguments' => 'The arguments to send to the container that the monitoring job runs.
', 'ModelQualityAppSpecification$ContainerArguments' => 'An array of arguments for the container used to run the monitoring job.
', 'MonitoringAppSpecification$ContainerArguments' => 'An array of arguments for the container used to run the monitoring job.
', ], ], 'MonitoringCsvDatasetFormat' => [ 'base' => 'Represents the CSV dataset format used when running a monitoring job.
', 'refs' => [ 'MonitoringDatasetFormat$Csv' => 'The CSV dataset used in the monitoring job.
', ], ], 'MonitoringDatapointsToAlert' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$DatapointsToAlert' => 'Within EvaluationPeriod, how many execution failures will raise an alert.
Within EvaluationPeriod, how many execution failures will raise an alert.
Represents the dataset format used when running a monitoring job.
', 'refs' => [ 'BatchTransformInput$DatasetFormat' => 'The dataset format for your batch transform job.
', ], ], 'MonitoringEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$Environment' => 'Sets the environment variables in the container that the monitoring job runs.
', 'ModelBiasAppSpecification$Environment' => 'Sets the environment variables in the Docker container.
', 'ModelExplainabilityAppSpecification$Environment' => 'Sets the environment variables in the Docker container.
', 'ModelQualityAppSpecification$Environment' => 'Sets the environment variables in the container that the monitoring job runs.
', 'MonitoringJobDefinition$Environment' => 'Sets the environment variables in the Docker container.
', ], ], 'MonitoringEvaluationPeriod' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$EvaluationPeriod' => 'The number of most recent monitoring executions to consider when evaluating alert status.
', 'UpdateMonitoringAlertRequest$EvaluationPeriod' => 'The number of most recent monitoring executions to consider when evaluating alert status.
', ], ], 'MonitoringExecutionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$SortBy' => 'Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.
Summary of information about the last monitoring job to run.
', 'refs' => [ 'DescribeMonitoringScheduleResponse$LastMonitoringExecutionSummary' => 'Describes metadata on the last execution to run, if there was one.
', 'ModelDashboardMonitoringSchedule$LastMonitoringExecutionSummary' => NULL, 'MonitoringExecutionSummaryList$member' => NULL, 'MonitoringSchedule$LastMonitoringExecutionSummary' => NULL, ], ], 'MonitoringExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsResponse$MonitoringExecutionSummaries' => 'A JSON array in which each element is a summary for a monitoring execution.
', ], ], 'MonitoringGroundTruthS3Input' => [ 'base' => 'The ground truth labels for the dataset used for the monitoring job.
', 'refs' => [ 'ModelBiasJobInput$GroundTruthS3Input' => 'Location of ground truth labels to use in model bias job.
', 'ModelQualityJobInput$GroundTruthS3Input' => 'The ground truth label provided for the model.
', ], ], 'MonitoringInput' => [ 'base' => 'The inputs for a monitoring job.
', 'refs' => [ 'MonitoringInputs$member' => NULL, ], ], 'MonitoringInputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringJobDefinition$MonitoringInputs' => 'The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
', ], ], 'MonitoringJobDefinition' => [ 'base' => 'Defines the monitoring job.
', 'refs' => [ 'MonitoringScheduleConfig$MonitoringJobDefinition' => 'Defines the monitoring job.
', ], ], 'MonitoringJobDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the job definition.
', 'CreateModelBiasJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model bias job.
', 'CreateModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model explainability job.
', 'CreateModelQualityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model quality monitoring job.
', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the data quality monitoring job definition.
', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model bias job.
', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model explainability job.
', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model quality job.
', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionArn' => 'The Amazon Resource Name (ARN) of the monitoring job.
', ], ], 'MonitoringJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobDefinitionName' => 'The name for the monitoring job definition.
', 'CreateModelBiasJobDefinitionRequest$JobDefinitionName' => 'The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'CreateModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '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.
', 'CreateModelQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the monitoring job definition.
', 'DeleteDataQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the data quality monitoring job definition to delete.
', 'DeleteModelBiasJobDefinitionRequest$JobDefinitionName' => 'The name of the model bias job definition to delete.
', 'DeleteModelExplainabilityJobDefinitionRequest$JobDefinitionName' => 'The name of the model explainability job definition to delete.
', 'DeleteModelQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the model quality monitoring job definition to delete.
', 'DescribeDataQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the data quality monitoring job definition to describe.
', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionName' => 'The name of the data quality monitoring job definition.
', 'DescribeModelBiasJobDefinitionRequest$JobDefinitionName' => 'The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionName' => 'The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '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.
', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionName' => 'The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeModelQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionName' => 'The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'ListMonitoringExecutionsRequest$MonitoringJobDefinitionName' => 'Gets a list of the monitoring job runs of the specified monitoring job definitions.
', 'ListMonitoringSchedulesRequest$MonitoringJobDefinitionName' => 'Gets a list of the monitoring schedules for the specified monitoring job definition.
', 'MonitoringExecutionSummary$MonitoringJobDefinitionName' => 'The name of the monitoring job.
', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionName' => 'The name of the monitoring job.
', 'MonitoringScheduleConfig$MonitoringJobDefinitionName' => 'The name of the monitoring job definition to schedule.
', 'MonitoringScheduleSummary$MonitoringJobDefinitionName' => 'The name of the monitoring job definition that the schedule is for.
', ], ], 'MonitoringJobDefinitionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsRequest$SortBy' => 'The field to sort results by. The default is CreationTime.
Whether to sort results by the Name or CreationTime field. The default is CreationTime.
Whether to sort results by the Name or CreationTime field. The default is CreationTime.
The field to sort results by. The default is CreationTime.
Summary information about a monitoring job.
', 'refs' => [ 'MonitoringJobDefinitionSummaryList$member' => NULL, ], ], 'MonitoringJobDefinitionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsResponse$JobDefinitionSummaries' => 'A list of data quality monitoring job definitions.
', 'ListModelBiasJobDefinitionsResponse$JobDefinitionSummaries' => 'A JSON array in which each element is a summary for a model bias jobs.
', 'ListModelExplainabilityJobDefinitionsResponse$JobDefinitionSummaries' => 'A JSON array in which each element is a summary for a explainability bias jobs.
', 'ListModelQualityJobDefinitionsResponse$JobDefinitionSummaries' => 'A list of summaries of model quality monitoring job definitions.
', ], ], 'MonitoringJsonDatasetFormat' => [ 'base' => 'Represents the JSON dataset format used when running a monitoring job.
', 'refs' => [ 'MonitoringDatasetFormat$Json' => 'The JSON dataset used in the monitoring job
', ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'MonitoringStoppingCondition$MaxRuntimeInSeconds' => '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.
The networking configuration for the monitoring job.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$NetworkConfig' => 'Specifies networking configuration for the monitoring job.
', 'CreateModelBiasJobDefinitionRequest$NetworkConfig' => 'Networking options for a model bias job.
', 'CreateModelExplainabilityJobDefinitionRequest$NetworkConfig' => 'Networking options for a model explainability job.
', 'CreateModelQualityJobDefinitionRequest$NetworkConfig' => 'Specifies the network configuration for the monitoring job.
', 'DescribeDataQualityJobDefinitionResponse$NetworkConfig' => 'The networking configuration for the data quality monitoring job.
', 'DescribeModelBiasJobDefinitionResponse$NetworkConfig' => 'Networking options for a model bias job.
', 'DescribeModelExplainabilityJobDefinitionResponse$NetworkConfig' => 'Networking options for a model explainability job.
', 'DescribeModelQualityJobDefinitionResponse$NetworkConfig' => 'Networking options for a model quality job.
', ], ], 'MonitoringOutput' => [ 'base' => 'The output object for a monitoring job.
', 'refs' => [ 'MonitoringOutputs$member' => NULL, ], ], 'MonitoringOutputConfig' => [ 'base' => 'The output configuration for monitoring jobs.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobOutputConfig' => NULL, 'CreateModelBiasJobDefinitionRequest$ModelBiasJobOutputConfig' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobOutputConfig' => NULL, 'CreateModelQualityJobDefinitionRequest$ModelQualityJobOutputConfig' => NULL, 'DescribeDataQualityJobDefinitionResponse$DataQualityJobOutputConfig' => NULL, 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobOutputConfig' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobOutputConfig' => NULL, 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobOutputConfig' => NULL, 'MonitoringJobDefinition$MonitoringOutputConfig' => 'The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
', ], ], 'MonitoringOutputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringOutputConfig$MonitoringOutputs' => 'Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.
', ], ], 'MonitoringParquetDatasetFormat' => [ 'base' => 'Represents the Parquet dataset format used when running a monitoring job.
', 'refs' => [ 'MonitoringDatasetFormat$Parquet' => 'The Parquet dataset used in the monitoring job
', ], ], 'MonitoringProblemType' => [ 'base' => NULL, 'refs' => [ 'ModelQualityAppSpecification$ProblemType' => 'The machine learning problem type of the model that the monitoring job monitors.
', ], ], 'MonitoringResources' => [ 'base' => 'Identifies the resources to deploy for a monitoring job.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobResources' => NULL, 'CreateModelBiasJobDefinitionRequest$JobResources' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$JobResources' => NULL, 'CreateModelQualityJobDefinitionRequest$JobResources' => NULL, 'DescribeDataQualityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelBiasJobDefinitionResponse$JobResources' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelQualityJobDefinitionResponse$JobResources' => NULL, 'MonitoringJobDefinition$MonitoringResources' => '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.
', ], ], 'MonitoringS3Output' => [ 'base' => 'Information about where and how you want to store the results of a monitoring job.
', 'refs' => [ 'MonitoringOutput$S3Output' => 'The Amazon S3 storage location where the results of a monitoring job are saved.
', ], ], 'MonitoringS3Uri' => [ 'base' => NULL, 'refs' => [ 'MonitoringGroundTruthS3Input$S3Uri' => 'The address of the Amazon S3 location of the ground truth labels.
', 'MonitoringS3Output$S3Uri' => 'A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
', ], ], 'MonitoringSchedule' => [ 'base' => 'A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.
', 'refs' => [ 'MonitoringScheduleList$member' => NULL, ], ], 'MonitoringScheduleArn' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleResponse$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'DescribeMonitoringScheduleResponse$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'DescribeProcessingJobResponse$MonitoringScheduleArn' => 'The ARN of a monitoring schedule for an endpoint associated with this processing job.
', 'ModelDashboardMonitoringSchedule$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of a monitoring schedule.
', 'MonitoringSchedule$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'MonitoringScheduleSummary$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'ProcessingJob$MonitoringScheduleArn' => 'The ARN of a monitoring schedule for an endpoint associated with this processing job.
', 'UpdateMonitoringAlertResponse$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'UpdateMonitoringScheduleResponse$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', ], ], 'MonitoringScheduleConfig' => [ 'base' => 'Configures the monitoring schedule and defines the monitoring job.
', 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleConfig' => 'The configuration object that specifies the monitoring schedule and defines the monitoring job.
', 'DescribeMonitoringScheduleResponse$MonitoringScheduleConfig' => 'The configuration object that specifies the monitoring schedule and defines the monitoring job.
', 'ModelDashboardMonitoringSchedule$MonitoringScheduleConfig' => NULL, 'MonitoringSchedule$MonitoringScheduleConfig' => NULL, 'UpdateMonitoringScheduleRequest$MonitoringScheduleConfig' => 'The configuration object that specifies the monitoring schedule and defines the monitoring job.
', ], ], 'MonitoringScheduleList' => [ 'base' => NULL, 'refs' => [ 'Endpoint$MonitoringSchedules' => 'A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.
', ], ], 'MonitoringScheduleName' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
', 'DeleteMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the monitoring schedule to delete.
', 'DescribeMonitoringScheduleRequest$MonitoringScheduleName' => 'Name of a previously created monitoring schedule.
', 'DescribeMonitoringScheduleResponse$MonitoringScheduleName' => 'Name of the monitoring schedule.
', 'ListMonitoringAlertHistoryRequest$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'ListMonitoringAlertsRequest$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'ListMonitoringExecutionsRequest$MonitoringScheduleName' => 'Name of a specific schedule to fetch jobs for.
', 'ModelDashboardMonitoringSchedule$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'MonitoringAlertHistorySummary$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'MonitoringExecutionSummary$MonitoringScheduleName' => 'The name of the monitoring schedule.
', 'MonitoringSchedule$MonitoringScheduleName' => 'The name of the monitoring schedule.
', 'MonitoringScheduleSummary$MonitoringScheduleName' => 'The name of the monitoring schedule.
', 'StartMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the schedule to start.
', 'StopMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the schedule to stop.
', 'UpdateMonitoringAlertRequest$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'UpdateMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
', ], ], 'MonitoringScheduleSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesRequest$SortBy' => 'Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.
Summarizes the monitoring schedule.
', 'refs' => [ 'MonitoringScheduleSummaryList$member' => NULL, ], ], 'MonitoringScheduleSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesResponse$MonitoringScheduleSummaries' => 'A JSON array in which each element is a summary for a monitoring schedule.
', ], ], 'MonitoringStatisticsResource' => [ 'base' => 'The statistics resource for a monitoring job.
', 'refs' => [ 'DataQualityBaselineConfig$StatisticsResource' => NULL, 'MonitoringBaselineConfig$StatisticsResource' => 'The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
', ], ], 'MonitoringStoppingCondition' => [ 'base' => 'A time limit for how long the monitoring job is allowed to run before stopping.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelBiasJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelQualityJobDefinitionRequest$StoppingCondition' => NULL, 'DescribeDataQualityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelBiasJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelQualityJobDefinitionResponse$StoppingCondition' => NULL, 'MonitoringJobDefinition$StoppingCondition' => 'Specifies a time limit for how long the monitoring job is allowed to run.
', ], ], 'MonitoringTimeOffsetString' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$StartTimeOffset' => '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.
', 'BatchTransformInput$EndTimeOffset' => '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.
', 'EndpointInput$StartTimeOffset' => '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.
', 'EndpointInput$EndTimeOffset' => '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.
', ], ], 'MonitoringType' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringType' => '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 filter that returns only the monitoring job runs of the specified monitoring type.
', 'ListMonitoringSchedulesRequest$MonitoringTypeEquals' => 'A filter that returns only the monitoring schedules for the specified monitoring type.
', 'ModelDashboardMonitoringSchedule$MonitoringType' => 'The monitor type of a model monitor.
', 'MonitoringExecutionSummary$MonitoringType' => 'The type of the monitoring job.
', 'MonitoringSchedule$MonitoringType' => 'The type of the monitoring job definition to schedule.
', 'MonitoringScheduleConfig$MonitoringType' => 'The type of the monitoring job definition to schedule.
', 'MonitoringScheduleSummary$MonitoringType' => 'The type of the monitoring job definition that the schedule is for.
', ], ], 'MountPath' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$MountPath' => '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.
', ], ], 'MultiModelConfig' => [ 'base' => 'Specifies additional configuration for hosting multi-model endpoints.
', 'refs' => [ 'ContainerDefinition$MultiModelConfig' => 'Specifies additional configuration for multi-model endpoints.
', ], ], 'NameContains' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$NameContains' => 'A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
', 'ListCompilationJobsRequest$NameContains' => 'A filter that returns the model compilation jobs whose name contains a specified string.
', 'ListDataQualityJobDefinitionsRequest$NameContains' => '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.
', 'ListDeviceFleetsRequest$NameContains' => 'Filter for fleets containing this name in their fleet device name.
', 'ListEdgeDeploymentPlansRequest$NameContains' => 'Selects edge deployment plans with names containing this name.
', 'ListEdgeDeploymentPlansRequest$DeviceFleetNameContains' => 'Selects edge deployment plans with a device fleet name containing this name.
', 'ListEdgePackagingJobsRequest$NameContains' => 'Filter for jobs containing this name in their packaging job name.
', 'ListEdgePackagingJobsRequest$ModelNameContains' => 'Filter for jobs where the model name contains this string.
', 'ListHubContentsRequest$NameContains' => 'Only list hub content if the name contains the specified string.
', 'ListHubsRequest$NameContains' => 'Only list hubs with names that contain the specified string.
', 'ListHyperParameterTuningJobsRequest$NameContains' => 'A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
', 'ListInferenceExperimentsRequest$NameContains' => 'Selects inference experiments whose names contain this name.
', 'ListInferenceRecommendationsJobsRequest$NameContains' => 'A string in the job name. This filter returns only recommendations whose name contains the specified string.
', 'ListLabelingJobsRequest$NameContains' => 'A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
', 'ListModelBiasJobDefinitionsRequest$NameContains' => 'Filter for model bias jobs whose name contains a specified string.
', 'ListModelExplainabilityJobDefinitionsRequest$NameContains' => 'Filter for model explainability jobs whose name contains a specified string.
', 'ListModelPackageGroupsInput$NameContains' => 'A string in the model group name. This filter returns only model groups whose name contains the specified string.
', 'ListModelPackagesInput$NameContains' => 'A string in the model package name. This filter returns only model packages whose name contains the specified string.
', 'ListModelQualityJobDefinitionsRequest$NameContains' => 'A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.
', 'ListMonitoringSchedulesRequest$NameContains' => 'Filter for monitoring schedules whose name contains a specified string.
', 'ListTrainingJobsRequest$NameContains' => 'A string in the training job name. This filter returns only training jobs whose name contains the specified string.
', 'ListTransformJobsRequest$NameContains' => 'A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
', ], ], 'NeoVpcConfig' => [ 'base' => '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 Compilation Jobs Access to Resources in Your Amazon VPC.
', 'refs' => [ 'CreateCompilationJobRequest$VpcConfig' => '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.
', 'DescribeCompilationJobResponse$VpcConfig' => '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.
', ], ], 'NeoVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSecurityGroupIds$member' => NULL, ], ], 'NeoVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$SecurityGroupIds' => '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 accessing the model in Amazon S3.
', ], ], 'NestedFilters' => [ 'base' => '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"}\'
A list of nested filter objects.
', ], ], 'NetworkConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateProcessingJobRequest$NetworkConfig' => '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.
', 'DescribeProcessingJobResponse$NetworkConfig' => 'Networking options for a processing job.
', 'MonitoringJobDefinition$NetworkConfig' => 'Specifies networking options for an monitoring job.
', 'ProcessingJob$NetworkConfig' => NULL, ], ], 'NetworkInterfaceId' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NetworkInterfaceId' => 'The network interface IDs that SageMaker created at the time of creating the instance.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceRequest$NextToken' => 'Next token of device description.
', 'DescribeDeviceResponse$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'DescribeEdgeDeploymentPlanRequest$NextToken' => 'If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.
', 'DescribeEdgeDeploymentPlanResponse$NextToken' => 'Token to use when calling the next set of stages in the edge deployment plan.
', 'DescribeFeatureGroupRequest$NextToken' => 'A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.
A token to resume pagination of the list of Features (FeatureDefinitions).
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 token for getting the next set of actions, if there are any.
', 'ListAlgorithmsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
', 'ListAliasesRequest$NextToken' => '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.
A token for getting the next set of aliases, if more aliases exist.
', 'ListAppImageConfigsRequest$NextToken' => '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.
A token for getting the next set of AppImageConfigs, if there are any.
', 'ListAppsRequest$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListAppsResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListArtifactsRequest$NextToken' => '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.
A token for getting the next set of artifacts, if there are any.
', 'ListAssociationsRequest$NextToken' => '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.
A token for getting the next set of associations, if there are any.
', 'ListAutoMLJobsRequest$NextToken' => 'If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
', 'ListAutoMLJobsResponse$NextToken' => 'If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
', 'ListCandidatesForAutoMLJobRequest$NextToken' => 'If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
', 'ListCandidatesForAutoMLJobResponse$NextToken' => 'If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
', 'ListCodeRepositoriesInput$NextToken' => '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.
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.
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.
If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.
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 token for getting the next set of contexts, if there are any.
', 'ListDataQualityJobDefinitionsRequest$NextToken' => '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.>
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.
The response from the last list when returning a list large enough to need tokening.
', 'ListDeviceFleetsResponse$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListDevicesRequest$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListDevicesResponse$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListDomainsRequest$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListDomainsResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListEdgeDeploymentPlansRequest$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListEdgeDeploymentPlansResponse$NextToken' => 'The token to use when calling the next page of results.
', 'ListEdgePackagingJobsRequest$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListEdgePackagingJobsResponse$NextToken' => 'Token to use when calling the next page of results.
', 'ListExperimentsRequest$NextToken' => '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.
A token for getting the next set of experiments, if there are any.
', 'ListFeatureGroupsRequest$NextToken' => 'A token to resume pagination of ListFeatureGroups results.
A token to resume pagination of ListFeatureGroups results.
A token to resume pagination.
', 'ListFlowDefinitionsResponse$NextToken' => 'A token to resume pagination.
', 'ListHubContentVersionsRequest$NextToken' => 'If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.
', 'ListHubContentsRequest$NextToken' => 'If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.
', 'ListHubsRequest$NextToken' => 'If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
', 'ListHumanTaskUisRequest$NextToken' => 'A token to resume pagination.
', 'ListHumanTaskUisResponse$NextToken' => 'A token to resume pagination.
', 'ListHyperParameterTuningJobsRequest$NextToken' => '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.
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.
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.
A token for getting the next set of versions, if there are any.
', 'ListImagesRequest$NextToken' => '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.
A token for getting the next set of images, if there are any.
', 'ListInferenceExperimentsRequest$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListInferenceExperimentsResponse$NextToken' => 'The token to use when calling the next page of results.
', 'ListInferenceRecommendationsJobStepsRequest$NextToken' => 'A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.
', 'ListInferenceRecommendationsJobStepsResponse$NextToken' => 'A token that you can specify in your next request to return more results from the list.
', 'ListInferenceRecommendationsJobsRequest$NextToken' => '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.
A token for getting the next set of recommendations, if there are any.
', 'ListLabelingJobsForWorkteamRequest$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
', 'ListLabelingJobsRequest$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
', 'ListLineageGroupsRequest$NextToken' => 'If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
', 'ListLineageGroupsResponse$NextToken' => 'If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
', 'ListModelBiasJobDefinitionsRequest$NextToken' => 'The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
', 'ListModelBiasJobDefinitionsResponse$NextToken' => 'If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
', 'ListModelCardExportJobsRequest$NextToken' => '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 card export jobs, use it in the subsequent request.
', 'ListModelCardVersionsRequest$NextToken' => '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 card versions, use it in the subsequent request.
', 'ListModelCardsRequest$NextToken' => '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 cards, use it in the subsequent request.
', 'ListModelExplainabilityJobDefinitionsRequest$NextToken' => 'The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
', 'ListModelExplainabilityJobDefinitionsResponse$NextToken' => 'If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
', 'ListModelMetadataRequest$NextToken' => '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 token for getting the next set of recommendations, if there are any.
', 'ListModelPackageGroupsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.
', 'ListModelPackagesInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
', 'ListModelQualityJobDefinitionsRequest$NextToken' => '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.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.
', 'ListMonitoringAlertHistoryRequest$NextToken' => '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 alerts, use it in the subsequent request.
', 'ListMonitoringAlertsRequest$NextToken' => '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 alerts, use it in the subsequent request.
', 'ListMonitoringExecutionsRequest$NextToken' => 'The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
', 'ListMonitoringExecutionsResponse$NextToken' => 'If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent reques
', 'ListMonitoringSchedulesRequest$NextToken' => 'The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
', 'ListMonitoringSchedulesResponse$NextToken' => 'If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
', 'ListNotebookInstanceLifecycleConfigsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.
', 'ListNotebookInstancesInput$NextToken' => ' 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.
If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, 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.
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.
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 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, 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 ListPipelines request was truncated, 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.
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.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.
', 'ListProjectsInput$NextToken' => '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, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.
A token to resume pagination of ListResourceCatalogs results.
A token to resume pagination of ListResourceCatalogs results.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListSpacesResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListStageDevicesRequest$NextToken' => 'The response from the last list when returning a list large enough to neeed tokening.
', 'ListStageDevicesResponse$NextToken' => 'The token to use when calling the next page of results.
', 'ListStudioLifecycleConfigsRequest$NextToken' => '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.
', 'ListStudioLifecycleConfigsResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListSubscribedWorkteamsRequest$NextToken' => '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 work teams, use it in the subsequent request.
', 'ListTagsInput$NextToken' => ' 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 token in your subsequent request to fetch next set of tokens.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$NextToken' => '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.
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, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
', 'ListTransformJobsRequest$NextToken' => '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.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.
', 'ListTrialComponentsRequest$NextToken' => '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.
A token for getting the next set of components, if there are any.
', 'ListTrialsRequest$NextToken' => '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.
A token for getting the next set of trials, if there are any.
', 'ListUserProfilesRequest$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListUserProfilesResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListWorkforcesRequest$NextToken' => 'A token to resume pagination.
', 'ListWorkforcesResponse$NextToken' => 'A token to resume pagination.
', 'ListWorkteamsRequest$NextToken' => '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 work teams, use it in the subsequent request.
', 'SearchRequest$NextToken' => '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.
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.
A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
', 'DescribeNotebookInstanceOutput$AcceleratorTypes' => 'A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
', 'UpdateNotebookInstanceInput$AcceleratorTypes' => 'A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
', ], ], 'NotebookInstanceArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceOutput$NotebookInstanceArn' => 'The Amazon Resource Name (ARN) of the notebook instance.
', 'DescribeNotebookInstanceOutput$NotebookInstanceArn' => 'The Amazon Resource Name (ARN) of the notebook instance.
', 'NotebookInstanceSummary$NotebookInstanceArn' => 'The Amazon Resource Name (ARN) of the notebook instance.
', ], ], 'NotebookInstanceLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the lifecycle configuration.
', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the lifecycle configuration.
', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the lifecycle configuration.
', ], ], 'NotebookInstanceLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceLifecycleHook$Content' => 'A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
', ], ], 'NotebookInstanceLifecycleConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigInput$OnCreate' => 'A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
', 'CreateNotebookInstanceLifecycleConfigInput$OnStart' => '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.
', 'DescribeNotebookInstanceLifecycleConfigOutput$OnCreate' => 'The shell script that runs only once, when you create a notebook instance.
', 'DescribeNotebookInstanceLifecycleConfigOutput$OnStart' => 'The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
', 'UpdateNotebookInstanceLifecycleConfigInput$OnCreate' => 'The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
', 'UpdateNotebookInstanceLifecycleConfigInput$OnStart' => '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.
', ], ], 'NotebookInstanceLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$LifecycleConfigName' => '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.
', 'CreateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration.
', 'DeleteNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration to delete.
', 'DescribeNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration to describe.
', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration.
', 'DescribeNotebookInstanceOutput$NotebookInstanceLifecycleConfigName' => '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
', 'ListNotebookInstancesInput$NotebookInstanceLifecycleConfigNameContains' => '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.
', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration.
', 'NotebookInstanceSummary$NotebookInstanceLifecycleConfigName' => '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.
', 'UpdateNotebookInstanceInput$LifecycleConfigName' => '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.
', 'UpdateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration.
', ], ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$NameContains' => 'A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
', ], ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortBy' => 'Sorts the list of results. The default is CreationTime.
The sort order for results.
', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'base' => 'Provides a summary of a notebook instance lifecycle configuration.
', 'refs' => [ 'NotebookInstanceLifecycleConfigSummaryList$member' => NULL, ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsOutput$NotebookInstanceLifecycleConfigs' => 'An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.
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 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.
', 'refs' => [ 'NotebookInstanceLifecycleConfigList$member' => NULL, ], ], 'NotebookInstanceName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$NotebookInstanceName' => 'The name of the new notebook instance.
', 'CreatePresignedNotebookInstanceUrlInput$NotebookInstanceName' => 'The name of the notebook instance.
', 'DeleteNotebookInstanceInput$NotebookInstanceName' => 'The name of the SageMaker notebook instance to delete.
', 'DescribeNotebookInstanceInput$NotebookInstanceName' => 'The name of the notebook instance that you want information about.
', 'DescribeNotebookInstanceOutput$NotebookInstanceName' => 'The name of the SageMaker notebook instance.
', 'NotebookInstanceSummary$NotebookInstanceName' => 'The name of the notebook instance that you want a summary for.
', 'StartNotebookInstanceInput$NotebookInstanceName' => 'The name of the notebook instance to start.
', 'StopNotebookInstanceInput$NotebookInstanceName' => 'The name of the notebook instance to terminate.
', 'UpdateNotebookInstanceInput$NotebookInstanceName' => 'The name of the notebook instance to update.
', ], ], 'NotebookInstanceNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$NameContains' => 'A string in the notebook instances\' name. This filter returns only notebook instances whose name contains the specified string.
', ], ], 'NotebookInstanceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortBy' => 'The field to sort results by. The default is Name.
The sort order for results.
', ], ], 'NotebookInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NotebookInstanceStatus' => 'The status of the notebook instance.
', 'ListNotebookInstancesInput$StatusEquals' => 'A filter that returns only notebook instances with the specified status.
', 'NotebookInstanceSummary$NotebookInstanceStatus' => 'The status of the notebook instance.
', ], ], 'NotebookInstanceSummary' => [ 'base' => 'Provides summary information for an SageMaker notebook instance.
', 'refs' => [ 'NotebookInstanceSummaryList$member' => NULL, ], ], 'NotebookInstanceSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesOutput$NotebookInstances' => 'An array of NotebookInstanceSummary objects, one for each notebook instance.
A JSON object that contains the URL string.
', 'DescribeNotebookInstanceOutput$Url' => 'The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
', 'NotebookInstanceSummary$Url' => 'The URL that you use to connect to the Jupyter notebook running in your notebook instance.
', ], ], 'NotebookInstanceVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$VolumeSizeInGB' => 'The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
', 'DescribeNotebookInstanceOutput$VolumeSizeInGB' => 'The size, in GB, of the ML storage volume attached to the notebook instance.
', 'UpdateNotebookInstanceInput$VolumeSizeInGB' => '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 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.
', ], ], 'NotebookOutputOption' => [ 'base' => NULL, 'refs' => [ 'SharingSettings$NotebookOutputOption' => 'Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
Configures Amazon SNS notifications of available or expiring work items for work teams.
', 'refs' => [ 'CreateWorkteamRequest$NotificationConfiguration' => 'Configures notification of workers regarding available or expiring work items.
', 'UpdateWorkteamRequest$NotificationConfiguration' => 'Configures SNS topic notifications for available or expiring work items
', 'Workteam$NotificationConfiguration' => 'Configures SNS notifications of available or expiring work items for work teams.
', ], ], 'NotificationTopicArn' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$NotificationTopicArn' => 'The ARN for the Amazon SNS topic to which notifications should be published.
', ], ], 'NumberOfHumanWorkersPerDataObject' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$NumberOfHumanWorkersPerDataObject' => 'The number of human workers that will label an object.
', 'LabelingJobForWorkteamSummary$NumberOfHumanWorkersPerDataObject' => 'The configured number of workers per data object.
', ], ], 'NumberOfSteps' => [ 'base' => NULL, 'refs' => [ 'Stairs$NumberOfSteps' => 'Specifies how many steps to perform during traffic.
', ], ], 'ObjectiveStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$ObjectiveStatus' => 'The objective\'s status.
', 'HyperParameterTrainingJobSummary$ObjectiveStatus' => 'The 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 number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
', 'ObjectiveStatusCounters$Pending' => 'The number of training jobs that are in progress and pending evaluation of their final objective metric.
', 'ObjectiveStatusCounters$Failed' => '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.
', ], ], 'ObjectiveStatusCounters' => [ 'base' => '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.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters' => 'The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
', 'HyperParameterTuningJobSearchEntity$ObjectiveStatusCounters' => NULL, 'HyperParameterTuningJobSummary$ObjectiveStatusCounters' => 'The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
', ], ], 'OfflineStoreConfig' => [ 'base' => '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.
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.
', 'DescribeFeatureGroupResponse$OfflineStoreConfig' => 'The 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 status of OfflineStore.
The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked
Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.
An OfflineStore status. Filters by OfflineStore status.
An OfflineStore status.
Use this parameter to configure your OIDC Identity Provider (IdP).
', 'refs' => [ 'CreateWorkforceRequest$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.
Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.
', ], ], 'OidcConfigForResponse' => [ 'base' => 'Your OIDC IdP workforce configuration.
', 'refs' => [ 'Workforce$OidcConfig' => 'The configuration of an OIDC Identity Provider (IdP) private workforce.
', ], ], 'OidcEndpoint' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$Issuer' => 'The OIDC IdP issuer used to configure your private workforce.
', 'OidcConfig$AuthorizationEndpoint' => 'The OIDC IdP authorization endpoint used to configure your private workforce.
', 'OidcConfig$TokenEndpoint' => 'The OIDC IdP token endpoint used to configure your private workforce.
', 'OidcConfig$UserInfoEndpoint' => 'The OIDC IdP user information endpoint used to configure your private workforce.
', 'OidcConfig$LogoutEndpoint' => 'The OIDC IdP logout endpoint used to configure your private workforce.
', 'OidcConfig$JwksUri' => 'The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
', 'OidcConfigForResponse$Issuer' => 'The OIDC IdP issuer used to configure your private workforce.
', 'OidcConfigForResponse$AuthorizationEndpoint' => 'The OIDC IdP authorization endpoint used to configure your private workforce.
', 'OidcConfigForResponse$TokenEndpoint' => 'The OIDC IdP token endpoint used to configure your private workforce.
', 'OidcConfigForResponse$UserInfoEndpoint' => 'The OIDC IdP user information endpoint used to configure your private workforce.
', 'OidcConfigForResponse$LogoutEndpoint' => 'The OIDC IdP logout endpoint used to configure your private workforce.
', 'OidcConfigForResponse$JwksUri' => 'The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
', ], ], 'OidcMemberDefinition' => [ 'base' => '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.
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.
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.
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.
The configuration for the OnlineStore.
Updates the feature group online store configuration.
', 'refs' => [ 'UpdateFeatureGroupRequest$OnlineStoreConfig' => 'Updates the feature group online store configuration.
', ], ], 'OnlineStoreSecurityConfig' => [ 'base' => 'The security configuration for OnlineStore.
Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
The size of the OnlineStore in bytes.
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."
The maximum value of the metric.
', 'TrialComponentMetricSummary$Min' => 'The minimum value of the metric.
', 'TrialComponentMetricSummary$Last' => 'The most recent value of the metric.
', 'TrialComponentMetricSummary$Avg' => 'The average value of the metric.
', 'TrialComponentMetricSummary$StdDev' => 'The standard deviation of the metric.
', ], ], 'OptionalInteger' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Count' => 'The number of samples used to generate the metric.
', ], ], 'OptionalVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$VolumeSizeInGB' => 'The size, in GB, of the ML storage volume attached to the processing instance.
', 'HyperParameterTuningResourceConfig$VolumeSizeInGB' => 'The 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.
The size, in GB, of the ML storage volume attached to the processing instance.
', ], ], 'OrderKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortOrder' => 'The sort order for results. The default is Descending.
The sort order for results. The default is Descending.
The sort order for results. The default is Descending.
The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
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.
Provides information about the output location for the compiled model and the target device the model runs on.
', 'DescribeCompilationJobResponse$OutputConfig' => 'Information about the output location for the compiled model and the target device that the model runs on.
', ], ], 'OutputDataConfig' => [ 'base' => 'Provides information about how to store model training results (model artifacts).
', 'refs' => [ 'CreateTrainingJobRequest$OutputDataConfig' => 'Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
', 'DescribeTrainingJobResponse$OutputDataConfig' => 'The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
', 'HyperParameterTrainingJobDefinition$OutputDataConfig' => 'Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
', 'TrainingJob$OutputDataConfig' => 'The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
', 'TrainingJobDefinition$OutputDataConfig' => 'the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
', ], ], 'OutputParameter' => [ 'base' => 'An output parameter of a pipeline step.
', 'refs' => [ 'OutputParameterList$member' => NULL, ], ], 'OutputParameterList' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$OutputParameters' => 'A list of the output parameters of the callback step.
', 'LambdaStepMetadata$OutputParameters' => 'A list of the output parameters of the Lambda step.
', 'SendPipelineExecutionStepSuccessRequest$OutputParameters' => 'A list of the output parameters of the callback step.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request
', 'ListEndpointsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
', 'ListModelsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.
', ], ], 'ParallelismConfiguration' => [ 'base' => 'Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.
', 'refs' => [ 'CreatePipelineRequest$ParallelismConfiguration' => 'This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.
', 'DescribePipelineExecutionResponse$ParallelismConfiguration' => 'The parallelism configuration applied to the pipeline.
', 'DescribePipelineResponse$ParallelismConfiguration' => 'Lists the parallelism configuration applied to the pipeline.
', 'Pipeline$ParallelismConfiguration' => 'The parallelism configuration applied to the pipeline.
', 'PipelineExecution$ParallelismConfiguration' => 'The parallelism configuration applied to the pipeline execution.
', 'RetryPipelineExecutionRequest$ParallelismConfiguration' => 'This configuration, if specified, overrides the parallelism configuration of the parent pipeline.
', 'StartPipelineExecutionRequest$ParallelismConfiguration' => 'This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
', 'UpdatePipelineExecutionRequest$ParallelismConfiguration' => 'This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
', 'UpdatePipelineRequest$ParallelismConfiguration' => 'If specified, it applies to all executions of this pipeline by default.
', ], ], 'Parameter' => [ 'base' => 'Assigns a value to a named Pipeline parameter.
', 'refs' => [ 'ParameterList$member' => NULL, ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$Name' => 'The name of the hyperparameter to optimize using Autotune.
', 'CategoricalParameterRange$Name' => 'The name of the categorical hyperparameter to tune.
', 'ContinuousParameterRange$Name' => 'The name of the continuous hyperparameter to tune.
', 'IntegerParameterRange$Name' => 'The name of the hyperparameter to search.
', ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineParametersForExecutionResponse$PipelineParameters' => 'Contains a list of pipeline parameters. This list can be empty.
', 'PipelineExecution$PipelineParameters' => 'Contains a list of pipeline parameters. This list can be empty.
', 'StartPipelineExecutionRequest$PipelineParameters' => 'Contains a list of pipeline parameters. This list can be empty.
', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Name' => 'The name of this hyperparameter. The name must be unique.
', ], ], 'ParameterRange' => [ 'base' => 'Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.
', 'refs' => [ 'HyperParameterSpecification$Range' => 'The allowed range for this hyperparameter.
', ], ], 'ParameterRanges' => [ 'base' => '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 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.
', ], ], 'ParameterType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Type' => 'The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.
An example value of the hyperparameter to optimize using Autotune.
', 'ContinuousParameterRange$MinValue' => '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 between MinValue value and this value for tuning.
The minimum floating-point value allowed.
', 'ContinuousParameterRangeSpecification$MaxValue' => 'The maximum floating-point value allowed.
', 'IntegerParameterRange$MinValue' => 'The minimum value of the hyperparameter to search.
', 'IntegerParameterRange$MaxValue' => 'The maximum value of the hyperparameter to search.
', 'IntegerParameterRangeSpecification$MinValue' => 'The minimum integer value allowed.
', 'IntegerParameterRangeSpecification$MaxValue' => 'The maximum integer value allowed.
', 'ParameterValues$member' => NULL, ], ], 'ParameterValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRange$Values' => 'A list of the categories for the hyperparameter.
', 'CategoricalParameterRangeSpecification$Values' => 'The allowed categories for the hyperparameter.
', ], ], 'Parent' => [ 'base' => '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.
', 'refs' => [ 'Parents$member' => NULL, ], ], 'ParentHyperParameterTuningJob' => [ 'base' => 'A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
', 'refs' => [ 'ParentHyperParameterTuningJobs$member' => NULL, ], ], 'ParentHyperParameterTuningJobs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$ParentHyperParameterTuningJobs' => '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.
', ], ], 'Parents' => [ 'base' => NULL, 'refs' => [ 'TrialComponent$Parents' => '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.
', ], ], 'PendingDeploymentSummary' => [ 'base' => 'The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.
', 'refs' => [ 'DescribeEndpointOutput$PendingDeploymentSummary' => '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.
', ], ], 'PendingProductionVariantSummary' => [ 'base' => '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.
An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.
', 'PendingDeploymentSummary$ShadowProductionVariants' => '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.
Percentage of devices in the fleet to deploy to the current stage.
', 'ShadowModelVariantConfig$SamplingPercentage' => 'The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.
', ], ], 'Phase' => [ 'base' => 'Defines the traffic pattern.
', 'refs' => [ 'Phases$member' => NULL, ], ], 'Phases' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$Phases' => 'Defines the phases traffic specification.
', ], ], 'Pipeline' => [ 'base' => 'A SageMaker Model Building Pipeline instance.
', 'refs' => [ 'SearchRecord$Pipeline' => NULL, ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the created pipeline.
', 'DeletePipelineResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline to delete.
', 'DescribePipelineExecutionResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'DescribePipelineResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'Pipeline$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'PipelineExecution$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline that was executed.
', 'PipelineSummary$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'UpdatePipelineResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the updated pipeline.
', ], ], 'PipelineDefinition' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDefinition' => 'The JSON pipeline definition of the pipeline.
', 'DescribePipelineDefinitionForExecutionResponse$PipelineDefinition' => 'The JSON pipeline definition.
', 'DescribePipelineResponse$PipelineDefinition' => 'The JSON pipeline definition.
', 'UpdatePipelineRequest$PipelineDefinition' => 'The JSON pipeline definition.
', ], ], 'PipelineDefinitionS3Location' => [ 'base' => 'The location of the pipeline definition stored in Amazon S3.
', 'refs' => [ 'CreatePipelineRequest$PipelineDefinitionS3Location' => 'The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
', 'UpdatePipelineRequest$PipelineDefinitionS3Location' => 'The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
', ], ], 'PipelineDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDescription' => 'A description of the pipeline.
', 'DescribePipelineResponse$PipelineDescription' => 'The description of the pipeline.
', 'Pipeline$PipelineDescription' => 'The description of the pipeline.
', 'PipelineSummary$PipelineDescription' => 'The description of the pipeline.
', 'UpdatePipelineRequest$PipelineDescription' => 'The description of the pipeline.
', ], ], 'PipelineExecution' => [ 'base' => 'An execution of a pipeline.
', 'refs' => [ 'SearchRecord$PipelineExecution' => NULL, ], ], 'PipelineExecutionArn' => [ 'base' => NULL, 'refs' => [ 'CacheHitResult$SourcePipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'DescribePipelineDefinitionForExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'DescribePipelineExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'DescribePipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'ListPipelineExecutionStepsRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'ListPipelineParametersForExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'PipelineExecution$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'PipelineExecutionSummary$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'RetryPipelineExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'RetryPipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'SelectiveExecutionConfig$SourcePipelineExecutionArn' => '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.
The ARN from an execution of the current pipeline.
', 'SendPipelineExecutionStepFailureResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'SendPipelineExecutionStepSuccessResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'StartPipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'StopPipelineExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'StopPipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'UpdatePipelineExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'UpdatePipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the updated pipeline execution.
', ], ], 'PipelineExecutionDescription' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDescription' => 'The description of the pipeline execution.
', 'PipelineExecution$PipelineExecutionDescription' => 'The description of the pipeline execution.
', 'PipelineExecutionSummary$PipelineExecutionDescription' => 'The description of the pipeline execution.
', 'StartPipelineExecutionRequest$PipelineExecutionDescription' => 'The description of the pipeline execution.
', 'UpdatePipelineExecutionRequest$PipelineExecutionDescription' => 'The description of the pipeline execution.
', ], ], 'PipelineExecutionFailureReason' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$FailureReason' => 'If the execution failed, a message describing why.
', 'PipelineExecution$FailureReason' => 'If the execution failed, a message describing why.
', ], ], 'PipelineExecutionName' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', 'PipelineExecution$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', 'PipelineExecutionSummary$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', 'StartPipelineExecutionRequest$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', 'UpdatePipelineExecutionRequest$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', ], ], 'PipelineExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionStatus' => 'The status of the pipeline execution.
', 'PipelineExecution$PipelineExecutionStatus' => 'The status of the pipeline status.
', 'PipelineExecutionSummary$PipelineExecutionStatus' => 'The status of the pipeline execution.
', ], ], 'PipelineExecutionStep' => [ 'base' => 'An execution of a step in a pipeline.
', 'refs' => [ 'PipelineExecutionStepList$member' => NULL, ], ], 'PipelineExecutionStepList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionStepsResponse$PipelineExecutionSteps' => '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.
Metadata for a step execution.
', 'refs' => [ 'PipelineExecutionStep$Metadata' => 'Metadata to run the pipeline step.
', ], ], 'PipelineExecutionSummary' => [ 'base' => 'A pipeline execution summary.
', 'refs' => [ 'PipelineExecutionSummaryList$member' => NULL, ], ], 'PipelineExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsResponse$PipelineExecutionSummaries' => '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.
', ], ], 'PipelineExperimentConfig' => [ 'base' => 'Specifies the names of the experiment and trial created by a pipeline.
', 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExperimentConfig' => NULL, 'PipelineExecution$PipelineExperimentConfig' => NULL, ], ], 'PipelineName' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineName' => 'The name of the pipeline.
', 'CreatePipelineRequest$PipelineDisplayName' => 'The display name of the pipeline.
', 'DeletePipelineRequest$PipelineName' => 'The name of the pipeline to delete.
', 'DescribePipelineResponse$PipelineName' => 'The name of the pipeline.
', 'DescribePipelineResponse$PipelineDisplayName' => 'The display name of the pipeline.
', 'ListPipelinesRequest$PipelineNamePrefix' => 'The prefix of the pipeline name.
', 'Pipeline$PipelineName' => 'The name of the pipeline.
', 'Pipeline$PipelineDisplayName' => 'The display name of the pipeline.
', 'PipelineSummary$PipelineName' => 'The name of the pipeline.
', 'PipelineSummary$PipelineDisplayName' => 'The display name of the pipeline.
', 'UpdatePipelineRequest$PipelineName' => 'The name of the pipeline to update.
', 'UpdatePipelineRequest$PipelineDisplayName' => 'The display name of the pipeline.
', ], ], 'PipelineNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineRequest$PipelineName' => 'The name or Amazon Resource Name (ARN) of the pipeline to describe.
', 'ListPipelineExecutionsRequest$PipelineName' => 'The name or Amazon Resource Name (ARN) of the pipeline.
', 'StartPipelineExecutionRequest$PipelineName' => 'The name or Amazon Resource Name (ARN) of the pipeline.
', ], ], 'PipelineParameterName' => [ 'base' => NULL, 'refs' => [ 'Parameter$Name' => 'The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.
', ], ], 'PipelineStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineResponse$PipelineStatus' => 'The status of the pipeline execution.
', 'Pipeline$PipelineStatus' => 'The status of the pipeline.
', ], ], 'PipelineSummary' => [ 'base' => 'A summary of a pipeline.
', 'refs' => [ 'PipelineSummaryList$member' => NULL, ], ], 'PipelineSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesResponse$PipelineSummaries' => '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.
The platform identifier of the notebook instance runtime environment.
', 'DescribeNotebookInstanceOutput$PlatformIdentifier' => 'The platform identifier of the notebook instance runtime environment.
', ], ], 'PolicyString' => [ 'base' => NULL, 'refs' => [ 'GetModelPackageGroupPolicyOutput$ResourcePolicy' => 'The resource policy for the model group.
', 'PutModelPackageGroupPolicyInput$ResourcePolicy' => 'The resource policy for the model group.
', ], ], 'PresignedDomainUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlResponse$AuthorizedUrl' => 'The presigned URL.
', ], ], 'ProbabilityThresholdAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ProbabilityThresholdAttribute' => 'The threshold for the class probability to be evaluated as a positive result.
', 'EndpointInput$ProbabilityThresholdAttribute' => 'The threshold for the class probability to be evaluated as a positive result.
', ], ], 'ProblemType' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$ProblemType' => 'Defines the type of supervised learning problem available for the candidates. For more information, see Amazon SageMaker Autopilot problem types.
', 'DescribeAutoMLJobResponse$ProblemType' => 'Returns the job\'s problem type.
', 'ResolvedAttributes$ProblemType' => 'The problem type.
', 'TabularJobConfig$ProblemType' => 'The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see Amazon 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 type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see Amazon SageMaker Autopilot problem types.
', ], ], 'ProcessingClusterConfig' => [ 'base' => 'Configuration for the cluster used to run a processing job.
', 'refs' => [ 'ProcessingResources$ClusterConfig' => 'The configuration for the resources in a cluster used to run the processing job.
', ], ], 'ProcessingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$key' => NULL, 'ProcessingEnvironmentMap$key' => NULL, ], ], 'ProcessingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$Environment' => 'The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
', 'DescribeProcessingJobResponse$Environment' => 'The environment variables set in the Docker container.
', 'ProcessingJob$Environment' => 'Sets the environment variables in the Docker container.
', ], ], 'ProcessingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$value' => NULL, 'ProcessingEnvironmentMap$value' => NULL, ], ], 'ProcessingFeatureStoreOutput' => [ 'base' => 'Configuration for processing job outputs in Amazon SageMaker Feature Store.
', 'refs' => [ 'ProcessingOutput$FeatureStoreOutput' => 'Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.
The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.
An array of inputs configuring the data to download into the processing container.
', 'DescribeProcessingJobResponse$ProcessingInputs' => 'The inputs for a processing job.
', 'ProcessingJob$ProcessingInputs' => 'List of input configurations for the processing job.
', ], ], 'ProcessingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$InstanceCount' => '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.
', 'ProcessingClusterConfig$InstanceCount' => '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.
', ], ], 'ProcessingInstanceType' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$InstanceType' => 'The instance type to deploy a custom rule for debugging a training job.
', 'MonitoringClusterConfig$InstanceType' => 'The ML compute instance type for the processing job.
', 'ProcessingClusterConfig$InstanceType' => 'The ML compute instance type for the processing job.
', 'ProfilerRuleConfiguration$InstanceType' => 'The instance type to deploy a custom rule for profiling a training job.
', ], ], 'ProcessingJob' => [ 'base' => 'An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.
', 'refs' => [ 'TrialComponentSourceDetail$ProcessingJob' => 'Information about a processing job that\'s the source of a trial component.
', ], ], 'ProcessingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobResponse$ProcessingJobArn' => 'The Amazon Resource Name (ARN) of the processing job.
', 'DebugRuleEvaluationStatus$RuleEvaluationJobArn' => 'The Amazon Resource Name (ARN) of the rule evaluation job.
', 'DescribeProcessingJobResponse$ProcessingJobArn' => 'The Amazon Resource Name (ARN) of the processing job.
', 'MonitoringExecutionSummary$ProcessingJobArn' => 'The Amazon Resource Name (ARN) of the monitoring job.
', 'ProcessingJob$ProcessingJobArn' => 'The ARN of the processing job.
', 'ProcessingJobStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the processing job.
', 'ProcessingJobSummary$ProcessingJobArn' => 'The Amazon Resource Name (ARN) of the processing job..
', 'ProfilerRuleEvaluationStatus$RuleEvaluationJobArn' => 'The Amazon Resource Name (ARN) of the rule evaluation job.
', ], ], 'ProcessingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingJobName' => 'The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DataQualityBaselineConfig$BaseliningJobName' => 'The name of the job that performs baselining for the data quality monitoring job.
', 'DescribeProcessingJobRequest$ProcessingJobName' => 'The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeProcessingJobResponse$ProcessingJobName' => 'The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'ModelBiasBaselineConfig$BaseliningJobName' => 'The name of the baseline model bias job.
', 'ModelExplainabilityBaselineConfig$BaseliningJobName' => 'The name of the baseline model explainability job.
', 'ModelQualityBaselineConfig$BaseliningJobName' => 'The name of the job that performs baselining for the monitoring job.
', 'MonitoringBaselineConfig$BaseliningJobName' => 'The name of the job that performs baselining for the monitoring job.
', 'ProcessingJob$ProcessingJobName' => 'The name of the processing job.
', 'ProcessingJobSummary$ProcessingJobName' => 'The name of the processing job.
', 'StopProcessingJobRequest$ProcessingJobName' => 'The name of the processing job to stop.
', ], ], 'ProcessingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ProcessingJobStatus' => 'Provides the status of a processing job.
', 'ListProcessingJobsRequest$StatusEquals' => 'A filter that retrieves only processing jobs with a specific status.
', 'ProcessingJob$ProcessingJobStatus' => 'The status of the processing job.
', 'ProcessingJobSummary$ProcessingJobStatus' => 'The status of the processing job.
', ], ], 'ProcessingJobStepMetadata' => [ 'base' => 'Metadata for a processing job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$ProcessingJob' => 'The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
', ], ], 'ProcessingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListProcessingJobsResponse$ProcessingJobSummaries' => 'An array of ProcessingJobSummary objects, each listing a processing job.
Summary of information about a processing job.
', 'refs' => [ 'ProcessingJobSummaries$member' => NULL, ], ], 'ProcessingLocalPath' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$LocalPath' => 'Path to the filesystem where the batch transform data is available to the container.
', 'DatasetDefinition$LocalPath' => '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).
Path to the filesystem where the endpoint data is available to the container.
', 'MonitoringS3Output$LocalPath' => 'The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.
', 'ProcessingS3Input$LocalPath' => '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).
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.
Specifies the maximum runtime in seconds.
', ], ], 'ProcessingOutput' => [ 'base' => 'Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.
Configuration for uploading output from the processing container.
', 'refs' => [ 'CreateProcessingJobRequest$ProcessingOutputConfig' => 'Output configuration for the processing job.
', 'DescribeProcessingJobResponse$ProcessingOutputConfig' => 'Output configuration for the processing job.
', 'ProcessingJob$ProcessingOutputConfig' => NULL, ], ], 'ProcessingOutputs' => [ 'base' => NULL, 'refs' => [ 'ProcessingOutputConfig$Outputs' => 'An array of outputs configuring the data to upload from the processing container.
', ], ], 'ProcessingResources' => [ 'base' => '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.
', 'refs' => [ 'CreateProcessingJobRequest$ProcessingResources' => '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.
', 'DescribeProcessingJobResponse$ProcessingResources' => '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.
', 'ProcessingJob$ProcessingResources' => NULL, ], ], 'ProcessingS3CompressionType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3CompressionType' => '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.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
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 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.
Configuration for downloading input data from Amazon S3 into the processing container.
', 'refs' => [ 'ProcessingInput$S3Input' => 'Configuration for downloading input data from Amazon S3 into the processing container.
', ], ], 'ProcessingS3InputMode' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3InputMode' => '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 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 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.
Configuration for uploading output data to Amazon S3 from the processing container.
', 'refs' => [ 'ProcessingOutput$S3Output' => 'Configuration for processing job outputs in Amazon S3.
', ], ], 'ProcessingS3UploadMode' => [ 'base' => NULL, 'refs' => [ 'MonitoringS3Output$S3UploadMode' => 'Whether to upload the results of the monitoring job continuously or after the job completes.
', 'ProcessingS3Output$S3UploadMode' => 'Whether to upload the results of the processing job continuously or after the job completes.
', ], ], 'ProcessingStoppingCondition' => [ 'base' => '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.
', 'refs' => [ 'CreateProcessingJobRequest$StoppingCondition' => 'The time limit for how long the processing job is allowed to run.
', 'DescribeProcessingJobResponse$StoppingCondition' => 'The time limit for how long the processing job is allowed to run.
', 'ProcessingJob$StoppingCondition' => NULL, ], ], 'ProcessingVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$VolumeSizeInGB' => 'The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.
', 'ProcessingClusterConfig$VolumeSizeInGB' => 'The 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.
Indicates CPU or GPU compatibility.
CPU: The image version is compatible with CPU.
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.
Indicates CPU or GPU compatibility.
CPU: The image version is compatible with CPU.
GPU: The image version is compatible with GPU.
The product identifier of the algorithm.
', 'ModelPackageContainerDefinition$ProductId' => 'The Amazon Web Services Marketplace product ID of the model package.
', ], ], 'ProductListings' => [ 'base' => NULL, 'refs' => [ 'Workteam$ProductListingIds' => 'The Amazon Marketplace identifier for a vendor\'s work team.
', ], ], 'ProductionVariant' => [ 'base' => '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.
', 'refs' => [ 'ProductionVariantList$member' => NULL, ], ], 'ProductionVariantAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$AcceleratorType' => 'The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
', 'ProductionVariant$AcceleratorType' => 'The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$ContainerStartupHealthCheckTimeoutInSeconds' => '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.
', ], ], 'ProductionVariantCoreDumpConfig' => [ 'base' => 'Specifies configuration for a core dump from the model container when the process crashes.
', 'refs' => [ 'ProductionVariant$CoreDumpConfig' => 'Specifies configuration for a core dump from the model container when the process crashes.
', ], ], 'ProductionVariantInstanceType' => [ 'base' => NULL, 'refs' => [ 'EndpointInputConfiguration$InstanceType' => 'The instance types to use for the load test.
', 'EndpointOutputConfiguration$InstanceType' => 'The instance type recommended by Amazon SageMaker Inference Recommender.
', 'PendingProductionVariantSummary$InstanceType' => 'The type of instances associated with the variant.
', 'ProductionVariant$InstanceType' => 'The ML compute instance type.
', 'RealTimeInferenceRecommendation$InstanceType' => 'The recommended instance type for Real-Time Inference.
', 'RealtimeInferenceInstanceTypes$member' => NULL, ], ], 'ProductionVariantList' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$ProductionVariants' => 'An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
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.
An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
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 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.
', ], ], 'ProductionVariantSSMAccess' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$EnableSSMAccess' => ' 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.
Specifies the serverless configuration for an endpoint variant.
', 'refs' => [ 'EndpointInputConfiguration$ServerlessConfig' => NULL, 'EndpointOutputConfiguration$ServerlessConfig' => NULL, 'PendingProductionVariantSummary$CurrentServerlessConfig' => 'The serverless configuration for the endpoint.
', 'PendingProductionVariantSummary$DesiredServerlessConfig' => 'The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.
', 'ProductionVariant$ServerlessConfig' => 'The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
', 'ProductionVariantSummary$CurrentServerlessConfig' => 'The serverless configuration for the endpoint.
', 'ProductionVariantSummary$DesiredServerlessConfig' => 'The serverless configuration requested for the endpoint update.
', ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'base' => 'Specifies the serverless update concurrency configuration for an endpoint variant.
', 'refs' => [ 'DesiredWeightAndCapacity$ServerlessUpdateConfig' => 'Specifies the serverless update concurrency configuration for an endpoint variant.
', ], ], 'ProductionVariantStatus' => [ 'base' => 'Describes the status of the production variant.
', 'refs' => [ 'ProductionVariantStatusList$member' => NULL, ], ], 'ProductionVariantStatusList' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$VariantStatus' => 'The endpoint variant status which describes the current deployment stage status or operational status.
', 'ProductionVariantSummary$VariantStatus' => 'The endpoint variant status which describes the current deployment stage status or operational status.
', ], ], 'ProductionVariantSummary' => [ 'base' => '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.
An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
', 'DescribeEndpointOutput$ShadowProductionVariants' => '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.
A list of the production variants hosted on the endpoint. Each production variant is a model.
', 'Endpoint$ShadowProductionVariants' => '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.
', ], ], 'ProductionVariantVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$VolumeSizeInGB' => '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.
', ], ], 'ProfilerConfig' => [ 'base' => 'Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
', 'refs' => [ 'CreateTrainingJobRequest$ProfilerConfig' => NULL, 'DescribeTrainingJobResponse$ProfilerConfig' => NULL, 'TrainingJob$ProfilerConfig' => NULL, ], ], 'ProfilerConfigForUpdate' => [ 'base' => 'Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.
', 'refs' => [ 'UpdateTrainingJobRequest$ProfilerConfig' => 'Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
', ], ], 'ProfilerRuleConfiguration' => [ 'base' => 'Configuration information for profiling rules.
', 'refs' => [ 'ProfilerRuleConfigurations$member' => NULL, ], ], 'ProfilerRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$ProfilerRuleConfigurations' => 'Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
', 'DescribeTrainingJobResponse$ProfilerRuleConfigurations' => 'Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
', 'UpdateTrainingJobRequest$ProfilerRuleConfigurations' => 'Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
', ], ], 'ProfilerRuleEvaluationStatus' => [ 'base' => 'Information about the status of the rule evaluation.
', 'refs' => [ 'ProfilerRuleEvaluationStatuses$member' => NULL, ], ], 'ProfilerRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilerRuleEvaluationStatuses' => 'Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.
', ], ], 'ProfilingIntervalInMilliseconds' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingIntervalInMilliseconds' => '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.
', 'ProfilerConfigForUpdate$ProfilingIntervalInMilliseconds' => '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' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingParameters' => '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 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.
Profiling status of a training job.
', ], ], 'ProgrammingLang' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ProgrammingLang' => 'The supported programming language and its version.
', 'DescribeImageVersionResponse$ProgrammingLang' => 'The supported programming language and its version.
', 'UpdateImageVersionRequest$ProgrammingLang' => 'The supported programming language and its version.
', ], ], 'Project' => [ 'base' => 'The properties of a project as returned by the Search API.
', 'refs' => [ 'SearchRecord$Project' => 'The properties of a project.
', ], ], 'ProjectArn' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', 'DescribeProjectOutput$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', 'Project$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', 'ProjectSummary$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', 'UpdateProjectOutput$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', ], ], 'ProjectEntityName' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$ProjectName' => 'The name of the project.
', 'DeleteProjectInput$ProjectName' => 'The name of the project to delete.
', 'DescribeProjectInput$ProjectName' => 'The name of the project to describe.
', 'DescribeProjectOutput$ProjectName' => 'The name of the project.
', 'ListProjectsInput$NameContains' => 'A filter that returns the projects whose name contains a specified string.
', 'Project$ProjectName' => 'The name of the project.
', 'ProjectSummary$ProjectName' => 'The name of the project.
', 'UpdateProjectInput$ProjectName' => 'The name of the project.
', ], ], 'ProjectId' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectId' => 'The ID of the new project.
', 'DescribeProjectOutput$ProjectId' => 'The ID of the project.
', 'Project$ProjectId' => 'The ID of the project.
', 'ProjectSummary$ProjectId' => 'The ID of the project.
', ], ], 'ProjectSortBy' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortBy' => 'The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
The status of the project.
', 'Project$ProjectStatus' => 'The status of the project.
', 'ProjectSummary$ProjectStatus' => 'The status of the project.
', ], ], 'ProjectSummary' => [ 'base' => 'Information about a project.
', 'refs' => [ 'ProjectSummaryList$member' => NULL, ], ], 'ProjectSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListProjectsOutput$ProjectSummaryList' => 'A list of summaries of projects.
', ], ], 'PropertyNameHint' => [ 'base' => NULL, 'refs' => [ 'PropertyNameQuery$PropertyNameHint' => 'Text that begins a property\'s name.
', ], ], 'PropertyNameQuery' => [ 'base' => 'Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.
Defines a property name hint. Only property names that begin with the specified hint are included in the response.
', ], ], 'PropertyNameSuggestion' => [ 'base' => 'A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.
A list of property names for a Resource that match a SuggestionQuery.
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.
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.
', 'refs' => [ 'ProvisioningParameters$member' => NULL, ], ], 'ProvisioningParameterKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Key' => 'The key that identifies a provisioning parameter.
', ], ], 'ProvisioningParameterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Value' => 'The value of the provisioning parameter.
', ], ], 'ProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisioningDetails$ProvisioningParameters' => 'A list of key value pairs that you specify when you provision a product.
', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningParameters' => 'A list of key value pairs that you specify when you provision a product.
', ], ], 'PublicWorkforceTaskPrice' => [ 'base' => 'Defines 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
The price that you pay for each task performed by an Amazon Mechanical Turk worker.
', ], ], 'PutModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'PutModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'QualityCheckStepMetadata' => [ 'base' => 'Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.
', 'refs' => [ 'PipelineExecutionStepMetadata$QualityCheck' => '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.
A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.
A 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 of Associations from the StartArn entity to the matched results.
Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.
A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
', ], ], 'QueryLineageTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$LineageTypes' => 'Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.
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.
Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.
A collection of settings that apply to an RSessionGateway app.
A collection of settings that configure the RSessionGateway app.
Indicates whether the current user has access to the RStudioServerPro app.
A collection of settings that configure user interaction with the RStudioServerPro app.
A collection of settings that configure user interaction with the RStudioServerPro app.
A collection of settings that configure the RStudioServerPro Domain-level app.
A collection of settings that configure the RStudioServerPro Domain-level app.
A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.
A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.
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 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.
', ], ], 'RealTimeInferenceConfig' => [ 'base' => 'The infrastructure configuration for deploying the model to a real-time inference endpoint.
', 'refs' => [ 'ModelInfrastructureConfig$RealTimeInferenceConfig' => 'The infrastructure configuration for deploying the model to real-time inference.
', ], ], 'RealTimeInferenceRecommendation' => [ 'base' => 'The recommended configuration to use for Real-Time Inference.
', 'refs' => [ 'RealTimeInferenceRecommendations$member' => NULL, ], ], 'RealTimeInferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RealTimeInferenceRecommendations' => 'A list of RealTimeInferenceRecommendation items.
', ], ], 'RealtimeInferenceInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedRealtimeInferenceInstanceTypes' => 'A list of the instance types that are used to generate inferences in real-time.
', 'InferenceSpecification$SupportedRealtimeInferenceInstanceTypes' => '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.
', ], ], 'RecommendationFailureReason' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInferenceBenchmark$FailureReason' => 'The reason why a benchmark failed.
', ], ], 'RecommendationJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobResponse$JobArn' => 'The Amazon Resource Name (ARN) of the recommendation job.
', 'DescribeInferenceRecommendationsJobResponse$JobArn' => 'The Amazon Resource Name (ARN) of the job.
', 'InferenceRecommendationsJob$JobArn' => 'The Amazon Resource Name (ARN) of the recommendation job.
', ], ], 'RecommendationJobCompilationJobName' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$CompilationJobName' => 'The name of the compilation job used to create the recommended model artifacts.
', ], ], 'RecommendationJobCompiledOutputConfig' => [ 'base' => 'Provides information about the output configuration for the compiled model.
', 'refs' => [ 'RecommendationJobOutputConfig$CompiledOutputConfig' => 'Provides information about the output configuration for the compiled model.
', ], ], 'RecommendationJobContainerConfig' => [ 'base' => '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.
Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.
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.
', ], ], 'RecommendationJobDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobDescription' => 'Description of the recommendation job.
', 'DescribeInferenceRecommendationsJobResponse$JobDescription' => 'The job description that you provided when you initiated the job.
', 'InferenceRecommendationsJob$JobDescription' => 'The job description.
', ], ], 'RecommendationJobInferenceBenchmark' => [ 'base' => 'The details for a specific benchmark from an Inference Recommender job.
', 'refs' => [ 'InferenceRecommendationsJobStep$InferenceBenchmark' => 'The details for a specific benchmark.
', ], ], 'RecommendationJobInputConfig' => [ 'base' => 'The input configuration of the recommendation job.
', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$InputConfig' => 'Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
', 'DescribeInferenceRecommendationsJobResponse$InputConfig' => 'Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.
', ], ], 'RecommendationJobName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobName' => '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.
', 'DescribeInferenceRecommendationsJobRequest$JobName' => 'The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeInferenceRecommendationsJobResponse$JobName' => 'The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'InferenceRecommendationsJob$JobName' => 'The name of the job.
', 'InferenceRecommendationsJobStep$JobName' => 'The name of the Inference Recommender job.
', 'ListInferenceRecommendationsJobStepsRequest$JobName' => 'The name for the Inference Recommender job.
', 'StopInferenceRecommendationsJobRequest$JobName' => 'The name of the job you want to stop.
', ], ], 'RecommendationJobOutputConfig' => [ 'base' => 'Provides information about the output configuration for the compiled model.
', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$OutputConfig' => 'Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
', ], ], 'RecommendationJobPayloadConfig' => [ 'base' => 'The configuration for the payload for a recommendation job.
', 'refs' => [ 'RecommendationJobContainerConfig$PayloadConfig' => 'Specifies the SamplePayloadUrl and all other sample payload-related fields.
Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.
', 'refs' => [ 'RecommendationJobInputConfig$ResourceLimit' => 'Defines the resource limit of the job.
', ], ], 'RecommendationJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$Status' => 'The status of the job.
', 'InferenceRecommendationsJob$Status' => 'The status of the job.
', 'InferenceRecommendationsJobStep$Status' => 'The current status of the benchmark.
', 'ListInferenceRecommendationsJobStepsRequest$Status' => 'A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
', 'ListInferenceRecommendationsJobsRequest$StatusEquals' => 'A filter that retrieves only inference recommendations jobs with a specific status.
', ], ], 'RecommendationJobStoppingConditions' => [ 'base' => 'Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.
', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$StoppingConditions' => 'A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.
', 'DescribeInferenceRecommendationsJobResponse$StoppingConditions' => 'The stopping conditions that you provided when you initiated the job.
', ], ], 'RecommendationJobSupportedContentTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobPayloadConfig$SupportedContentTypes' => 'The supported MIME types for the input data.
', ], ], 'RecommendationJobSupportedEndpointType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedEndpointType' => '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.
', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedInstanceTypes' => 'A list of the instance types that are used to generate inferences in real-time.
', ], ], 'RecommendationJobType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobType' => '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 job type that you provided when you initiated the job.
', 'InferenceRecommendationsJob$JobType' => 'The recommendation job type.
', ], ], 'RecommendationJobVpcConfig' => [ 'base' => 'Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
', 'refs' => [ 'RecommendationJobInputConfig$VpcConfig' => 'Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
', ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSecurityGroupIds$member' => NULL, ], ], 'RecommendationJobVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$SecurityGroupIds' => '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 to which you want to connect your model.
', ], ], 'RecommendationMetrics' => [ 'base' => 'The metrics of recommendations.
', 'refs' => [ 'InferenceRecommendation$Metrics' => 'The metrics used to decide what recommendation to make.
', 'RecommendationJobInferenceBenchmark$Metrics' => NULL, ], ], 'RecommendationStatus' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RecommendationStatus' => '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.
The type of the subtask.
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.
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.
', ], ], 'RedshiftClusterId' => [ 'base' => 'The Redshift cluster Identifier.
', 'refs' => [ 'RedshiftDatasetDefinition$ClusterId' => NULL, ], ], 'RedshiftDatabase' => [ 'base' => 'The name of the Redshift database used in Redshift query execution.
', 'refs' => [ 'RedshiftDatasetDefinition$Database' => NULL, ], ], 'RedshiftDatasetDefinition' => [ 'base' => 'Configuration for Redshift Dataset Definition input.
', 'refs' => [ 'DatasetDefinition$RedshiftDatasetDefinition' => NULL, ], ], 'RedshiftQueryString' => [ 'base' => 'The SQL query statements to be executed.
', 'refs' => [ 'RedshiftDatasetDefinition$QueryString' => NULL, ], ], 'RedshiftResultCompressionType' => [ 'base' => 'The compression used for Redshift query results.
', 'refs' => [ 'RedshiftDatasetDefinition$OutputCompression' => NULL, ], ], 'RedshiftResultFormat' => [ 'base' => 'The data storage format for Redshift query results.
', 'refs' => [ 'RedshiftDatasetDefinition$OutputFormat' => NULL, ], ], 'RedshiftUserName' => [ 'base' => 'The database user name used in Redshift query execution.
', 'refs' => [ 'RedshiftDatasetDefinition$DbUser' => NULL, ], ], 'RegisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterModelStepMetadata' => [ 'base' => 'Metadata for a register model job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$RegisterModel' => 'The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
', ], ], 'ReleaseNotes' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ReleaseNotes' => 'The maintainer description of the image version.
', 'DescribeImageVersionResponse$ReleaseNotes' => 'The maintainer description of the image version.
', 'UpdateImageVersionRequest$ReleaseNotes' => 'The maintainer description of the image version.
', ], ], 'RenderUiTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RenderUiTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenderableTask' => [ 'base' => 'Contains input values for a task.
', 'refs' => [ 'RenderUiTemplateRequest$Task' => 'A RenderableTask object containing a representative task to render.
A description of an error that occurred while rendering the template.
', 'refs' => [ 'RenderingErrorList$member' => NULL, ], ], 'RenderingErrorList' => [ 'base' => NULL, 'refs' => [ 'RenderUiTemplateResponse$Errors' => '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.
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.
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.
(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.
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.
', ], ], 'RepositoryUrl' => [ 'base' => NULL, 'refs' => [ 'CodeRepository$RepositoryUrl' => 'The URL of the Git repository.
', ], ], 'ResolvedAttributes' => [ 'base' => 'The resolved attributes.
', 'refs' => [ 'DescribeAutoMLJobResponse$ResolvedAttributes' => 'Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.
The Amazon Resource Name (ARN) of the resource that you want to tag.
', 'DeleteTagsInput$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource whose tags you want to delete.
', 'ListTagsInput$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
', ], ], 'ResourceCatalog' => [ 'base' => ' 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 Amazon Resource Name (ARN) of the ResourceCatalog.
A free form description of the ResourceCatalog.
A list of the requested ResourceCatalogs.
A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.
The name of the ResourceCatalog.
The value on which the resource catalog list is sorted.
', ], ], 'ResourceCatalogSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortOrder' => 'The order in which the resource catalogs are listed.
', ], ], 'ResourceConfig' => [ 'base' => 'Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.
', 'refs' => [ 'CreateTrainingJobRequest$ResourceConfig' => '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.
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
', 'HyperParameterTrainingJobDefinition$ResourceConfig' => '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.
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
', 'TrainingJobDefinition$ResourceConfig' => 'The resources, including the ML compute instances and ML storage volumes, to use for model training.
', ], ], 'ResourceConfigForUpdate' => [ 'base' => 'The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.
The training job ResourceConfig to update warm pool retention length.
The ID of the Amazon Elastic File System (EFS) managed by this Domain.
', ], ], 'ResourceInUse' => [ 'base' => 'Resource being accessed is in use.
', 'refs' => [], ], 'ResourceLimitExceeded' => [ 'base' => 'You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
', 'refs' => [], ], 'ResourceLimits' => [ 'base' => 'Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.
', 'refs' => [ 'HyperParameterTuningJobConfig$ResourceLimits' => 'The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.
', 'HyperParameterTuningJobSummary$ResourceLimits' => 'The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
', ], ], 'ResourceNotFound' => [ 'base' => 'Resource being access is not found.
', 'refs' => [], ], 'ResourcePolicyString' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyResponse$ResourcePolicy' => 'The resource policy that gives access to the lineage group in another account.
', ], ], 'ResourcePropertyName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => 'A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.
The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.
A suggested property name based on what you entered in the search textbox in the SageMaker console.
', 'SearchRequest$SortBy' => 'The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
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.
Specifies the ARN\'s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
', 'refs' => [ 'CreateAppRequest$ResourceSpec' => 'The instance type and the Amazon Resource Name (ARN) of the SageMaker 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.
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
', 'JupyterServerAppSettings$DefaultResourceSpec' => 'The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsRequest$Resource' => 'The name of the SageMaker resource to search for.
', 'SearchRequest$Resource' => 'The name of the SageMaker resource to search for.
', ], ], 'ResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'ResponseMIMETypes$member' => NULL, ], ], 'ResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedResponseMIMETypes' => 'The supported MIME types for the output data.
', 'InferenceSpecification$SupportedResponseMIMETypes' => 'The supported MIME types for the output data.
', ], ], 'RetentionPolicy' => [ 'base' => 'The retention policy for data stored on an Amazon Elastic File System (EFS) volume.
', 'refs' => [ 'DeleteDomainRequest$RetentionPolicy' => '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).
', ], ], 'RetentionType' => [ 'base' => NULL, 'refs' => [ 'RetentionPolicy$HomeEfsFileSystem' => 'The default is Retain, which specifies to keep the data stored on the EFS volume.
Specify Delete to delete the data stored on the EFS volume.
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.
The number of times to retry the job when the job fails due to an InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
The IAM roles that SageMaker uses to run the training jobs.
', 'CreateAutoMLJobRequest$RoleArn' => 'The ARN of the role that is used to access the data.
', 'CreateAutoMLJobV2Request$RoleArn' => 'The ARN of the role that is used to access the data.
', 'CreateCompilationJobRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
During model compilation, Amazon SageMaker 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, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateDeviceFleetRequest$RoleArn' => 'The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
', 'CreateEdgePackagingJobRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.
', 'CreateFeatureGroupRequest$RoleArn' => '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 role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'CreateInferenceExperimentRequest$RoleArn' => '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.
', 'CreateInferenceRecommendationsJobRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'CreateLabelingJobRequest$RoleArn' => '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.
', 'CreateModelBiasJobDefinitionRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateModelExplainabilityJobDefinitionRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateModelInput$ExecutionRoleArn' => '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.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateNotebookInstanceInput$RoleArn' => 'When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this 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.
The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
', 'CreateProcessingJobRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateTrainingJobRequest$RoleArn' => '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.
The ARN of the execution role for the space.
', 'DescribeAutoMLJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
', 'DescribeAutoMLJobV2Response$RoleArn' => 'The ARN of the Identity and Access Management role that has read permission to the input data location and write permission to the output data location in Amazon S3.
', 'DescribeCompilationJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
', 'DescribeDataQualityJobDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'DescribeDeviceFleetResponse$RoleArn' => 'The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
', 'DescribeEdgePackagingJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
', 'DescribeFeatureGroupResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
', 'DescribeFlowDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.
', 'DescribeImageResponse$RoleArn' => 'The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'DescribeInferenceExperimentResponse$RoleArn' => '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.
', 'DescribeInferenceRecommendationsJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.
', 'DescribeLabelingJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
', 'DescribeModelBiasJobDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
', 'DescribeModelExplainabilityJobDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
', 'DescribeModelOutput$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
', 'DescribeModelQualityJobDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'DescribeNotebookInstanceOutput$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role associated with the instance.
', 'DescribePipelineResponse$RoleArn' => 'The Amazon Resource Name (ARN) that the pipeline uses to execute.
', 'DescribeProcessingJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'DescribeTrainingJobResponse$RoleArn' => 'The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
', 'FeatureGroup$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
', 'HyperParameterTrainingJobDefinition$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
', 'InferenceExperimentSummary$RoleArn' => '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.
', 'InferenceRecommendationsJob$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'Model$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
', 'ModelPackageValidationSpecification$ValidationRole' => 'The IAM roles to be used for the validation of the model package.
', 'ModelRegisterSettings$CrossAccountModelRegisterRoleArn' => '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.
', 'MonitoringJobDefinition$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'Pipeline$RoleArn' => 'The Amazon Resource Name (ARN) of the role that created the pipeline.
', 'PipelineSummary$RoleArn' => 'The Amazon Resource Name (ARN) that the pipeline used to execute.
', 'ProcessingJob$RoleArn' => 'The ARN of the role used to create the processing job.
', 'RStudioServerProDomainSettings$DomainExecutionRoleArn' => 'The ARN of the execution role for the RStudioServerPro Domain-level app.
The execution role for the RStudioServerPro Domain-level app.
The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
', 'RenderUiTemplateRequest$RoleArn' => 'The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
', 'TimeSeriesForecastingSettings$AmazonForecastRoleArn' => '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.
The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
', 'UpdateDeviceFleetRequest$RoleArn' => 'The Amazon Resource Name (ARN) of the device.
', 'UpdateImageRequest$RoleArn' => 'The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'UpdateNotebookInstanceInput$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. 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.
The Amazon Resource Name (ARN) that the pipeline uses to execute.
', 'UserSettings$ExecutionRole' => 'The execution role for the user.
', ], ], 'RollingUpdatePolicy' => [ 'base' => 'Specifies a rolling deployment strategy for updating a SageMaker endpoint.
', 'refs' => [ 'DeploymentConfig$RollingUpdatePolicy' => 'Specifies a rolling deployment strategy for updating a SageMaker endpoint.
', ], ], 'RootAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$RootAccess' => 'Whether 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.
Whether 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.
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 name of the rule configuration. It must be unique relative to other rule configuration names.
', 'DebugRuleEvaluationStatus$RuleConfigurationName' => 'The name of the rule configuration.
', 'ProfilerRuleConfiguration$RuleConfigurationName' => 'The name of the rule configuration. It must be unique relative to other rule configuration names.
', 'ProfilerRuleEvaluationStatus$RuleConfigurationName' => 'The name of the rule configuration.
', ], ], 'RuleEvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$RuleEvaluationStatus' => 'Status of the rule evaluation.
', 'ProfilerRuleEvaluationStatus$RuleEvaluationStatus' => 'Status of the rule evaluation.
', ], ], 'RuleParameters' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleParameters' => 'Runtime configuration for rule container.
', 'ProfilerRuleConfiguration$RuleParameters' => 'Runtime configuration for rule container.
', ], ], 'S3DataDistribution' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataDistributionType' => '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.
Describes the S3 data source.
Your input bucket must be in the same Amazon Web Services region as your training job.
', 'refs' => [ 'DataSource$S3DataSource' => 'The S3 location of the data source that is associated with a channel.
', ], ], 'S3DataType' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataType' => '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.
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
Specifies the S3 location of ML model data to deploy.
', 'refs' => [ 'ModelDataSource$S3DataSource' => 'Specifies the S3 location of ML model data to deploy.
', ], ], 'S3ModelDataType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3DataType' => '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 the S3 path of ML model data to deploy.
', ], ], 'S3OutputPath' => [ 'base' => NULL, 'refs' => [ 'HubS3StorageConfig$S3OutputPath' => 'The Amazon S3 bucket prefix for hosting hub content.
', ], ], 'S3StorageConfig' => [ 'base' => 'The Amazon Simple Storage (Amazon S3) location and and security configuration for OfflineStore.
The Amazon Simple Storage (Amazon S3) location of OfflineStore.
The location in Amazon S3 where Athena query results are stored.
', 'AutoMLCandidateGenerationConfig$FeatureSpecificationS3Uri' => '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.
The Amazon S3 output path. Must be 128 characters or less.
', 'AutoMLS3DataSource$S3Uri' => 'The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.
', 'BatchDataCaptureConfig$DestinationS3Uri' => 'The Amazon S3 location being used to capture the data.
', 'CheckpointConfig$S3Uri' => 'Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
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.
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.
', 'DataQualityAppSpecification$RecordPreprocessorSourceUri' => '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 flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
', 'DataQualityAppSpecification$PostAnalyticsProcessorSourceUri' => 'An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
', 'DebugHookConfig$S3OutputPath' => 'Path to Amazon S3 storage location for metrics and tensors.
', 'DebugRuleConfiguration$S3OutputPath' => 'Path to Amazon S3 storage location for rules.
', 'DescribeEdgePackagingJobResponse$ModelArtifact' => 'The Amazon Simple Storage (S3) URI where model artifacts ares stored.
', 'DescribeLabelingJobResponse$LabelCategoryConfigS3Uri' => '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"
}
]
}
The Amazon Simple Storage (S3) bucker URI.
', 'FileSource$S3Uri' => 'The Amazon S3 URI for the file source.
', 'FlowDefinitionOutputConfig$S3OutputPath' => '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.
', 'InferenceRecommendationsJob$SamplePayloadUrl' => '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).
', 'InputConfig$S3Uri' => '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).
', 'LabelingJobOutput$OutputDatasetS3Uri' => 'The Amazon S3 bucket location of the manifest file for labeled data.
', 'LabelingJobOutputConfig$S3OutputPath' => 'The Amazon S3 location to write output data.
', 'LabelingJobS3DataSource$ManifestS3Uri' => '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.
', 'MetricsSource$S3Uri' => 'The S3 URI for the metrics source.
', 'ModelArtifacts$S3ModelArtifacts' => 'The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.
JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.
', 'ModelCardExportArtifacts$S3ExportArtifacts' => 'The Amazon S3 URI of the exported model artifacts.
', 'ModelCardExportOutputConfig$S3OutputPath' => 'The Amazon S3 output path to export your model card PDF.
', 'ModelExplainabilityAppSpecification$ConfigUri' => 'JSON formatted S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.
', 'ModelQualityAppSpecification$RecordPreprocessorSourceUri' => '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 flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
', 'ModelQualityAppSpecification$PostAnalyticsProcessorSourceUri' => 'An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
', 'MonitoringAppSpecification$RecordPreprocessorSourceUri' => '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 flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
', 'MonitoringAppSpecification$PostAnalyticsProcessorSourceUri' => 'An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
', 'MonitoringConstraintsResource$S3Uri' => 'The Amazon S3 URI for the constraints resource.
', 'MonitoringStatisticsResource$S3Uri' => 'The Amazon S3 URI for the statistics resource.
', 'OutputConfig$S3OutputLocation' => 'Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For 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 URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
', 'ProcessingS3Output$S3Uri' => 'A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
', 'ProfilerConfig$S3OutputPath' => 'Path to Amazon S3 storage location for system and framework metrics.
', 'ProfilerConfigForUpdate$S3OutputPath' => 'Path to Amazon S3 storage location for system and framework metrics.
', 'ProfilerRuleConfiguration$S3OutputPath' => 'Path to Amazon S3 storage location for rules.
', 'RecommendationJobCompiledOutputConfig$S3OutputUri' => 'Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.
', 'RedshiftDatasetDefinition$OutputS3Uri' => 'The location in Amazon S3 where the Redshift query results are stored.
', 'S3DataSource$S3Uri' => '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.
', 'S3StorageConfig$S3Uri' => 'The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following: s3://example-bucket/prefix/.
The S3 path where offline records are written.
', 'SharingSettings$S3OutputPath' => 'When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
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.
Path to Amazon S3 storage location for TensorBoard output.
', 'TimeSeriesForecastingJobConfig$FeatureSpecificationS3Uri' => '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 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.
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 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.
', 'WorkspaceSettings$S3ArtifactPath' => '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.
', ], ], 'SageMakerImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'DeleteImageVersionRequest$Alias' => 'The alias of the image to delete.
', 'DescribeImageVersionRequest$Alias' => 'The alias of the image version.
', 'ListAliasesRequest$Alias' => 'The alias of the image version.
', 'SageMakerImageVersionAliases$member' => NULL, 'UpdateImageVersionRequest$Alias' => 'The alias of the image version.
', ], ], 'SageMakerImageVersionAliases' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Aliases' => 'A list of aliases created with the image version.
', 'ListAliasesResponse$SageMakerImageVersionAliases' => 'A list of SageMaker image version aliases.
', 'UpdateImageVersionRequest$AliasesToAdd' => 'A list of aliases to add.
', 'UpdateImageVersionRequest$AliasesToDelete' => 'A list of aliases to delete.
', ], ], 'SagemakerServicecatalogStatus' => [ 'base' => NULL, 'refs' => [ 'GetSagemakerServicecatalogPortfolioStatusOutput$Status' => 'Whether Service Catalog is enabled or disabled in SageMaker.
', ], ], 'SampleWeightAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$SampleWeightAttributeName' => '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.
', 'TabularJobConfig$SampleWeightAttributeName' => '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.
', ], ], 'SamplingPercentage' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$InitialSamplingPercentage' => 'The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.
', 'DataCaptureConfigSummary$CurrentSamplingPercentage' => 'The percentage of requests being captured by your Endpoint.
', ], ], 'ScheduleConfig' => [ 'base' => 'Configuration details about the monitoring schedule.
', 'refs' => [ 'MonitoringScheduleConfig$ScheduleConfig' => 'Configures the monitoring schedule.
', ], ], 'ScheduleExpression' => [ 'base' => NULL, 'refs' => [ 'ScheduleConfig$ScheduleExpression' => 'A cron expression that describes details about the monitoring schedule.
Currently the only supported cron expressions are:
If you want to set the job to start every hour, please use the following:
Hourly: cron(0 * ? * * *)
If you want to start the job daily:
cron(0 [00-23] ? * * *)
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 will pick a time for running every day.
The status of an monitoring job.
', 'ListMonitoringSchedulesRequest$StatusEquals' => 'A filter that returns only monitoring schedules modified before a specified time.
', 'ModelDashboardMonitoringSchedule$MonitoringScheduleStatus' => 'The status of the monitoring schedule.
', 'MonitoringSchedule$MonitoringScheduleStatus' => '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.
The status of the monitoring schedule.
', ], ], 'SearchExpression' => [ 'base' => '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 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.
A list of search expression objects.
', ], ], 'SearchRecord' => [ 'base' => 'A single resource returned as part of the Search API response.
', 'refs' => [ 'SearchResultsList$member' => NULL, ], ], 'SearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchResultsList' => [ 'base' => NULL, 'refs' => [ 'SearchResponse$Results' => 'A list of SearchRecord objects.
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
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
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
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
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.
A history of all of the secondary statuses that the training job has transitioned through.
', 'TrainingJob$SecondaryStatusTransitions' => 'A history of all of the secondary statuses that the training job has transitioned through.
', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'GitConfig$SecretArn' => '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}
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}
The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
', 'DefaultSpaceSettings$SecurityGroups' => 'The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.
', 'DescribeNotebookInstanceOutput$SecurityGroups' => 'The IDs of the VPC security groups.
', 'UserSettings$SecurityGroups' => 'The security groups for the Amazon Virtual Private Cloud (VPC) that Studio 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 adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
', ], ], 'Seed' => [ 'base' => NULL, 'refs' => [ 'ShuffleConfig$Seed' => 'Determines the shuffling order in ShuffleConfig value.
A step selected to run in selective execution mode.
', 'refs' => [ 'SelectedStepList$member' => NULL, ], ], 'SelectedStepList' => [ 'base' => NULL, 'refs' => [ 'SelectiveExecutionConfig$SelectedSteps' => 'A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.
', ], ], 'SelectiveExecutionConfig' => [ 'base' => 'The selective execution configuration applied to the pipeline run.
', 'refs' => [ 'DescribePipelineExecutionResponse$SelectiveExecutionConfig' => 'The selective execution configuration applied to the pipeline run.
', 'PipelineExecution$SelectiveExecutionConfig' => 'The selective execution configuration applied to the pipeline run.
', 'StartPipelineExecutionRequest$SelectiveExecutionConfig' => 'The selective execution configuration applied to the pipeline run.
', ], ], 'SelectiveExecutionResult' => [ 'base' => 'The ARN from an execution of the current pipeline.
', 'refs' => [ 'PipelineExecutionStep$SelectiveExecutionResult' => 'The ARN from an execution of the current pipeline from which results are reused for this step.
', ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepFailureResponse' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerlessMaxConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MaxConcurrency' => 'The maximum number of concurrent invocations your serverless endpoint can process.
', 'ProductionVariantServerlessUpdateConfig$MaxConcurrency' => 'The updated maximum number of concurrent invocations your serverless endpoint can process.
', ], ], 'ServerlessMemorySizeInMB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MemorySizeInMB' => 'The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.
', ], ], 'ServerlessProvisionedConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$ProvisionedConcurrency' => 'The 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. Should be less than or equal to MaxConcurrency.
The ID of the provisioned product.
', 'ServiceCatalogProvisioningDetails$ProductId' => 'The ID of the product to provision.
', 'ServiceCatalogProvisioningDetails$ProvisioningArtifactId' => 'The ID of the provisioning artifact.
', 'ServiceCatalogProvisioningDetails$PathId' => 'The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningArtifactId' => 'The ID of the provisioning artifact.
', ], ], 'ServiceCatalogProvisionedProductDetails' => [ 'base' => 'Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
', 'refs' => [ 'DescribeProjectOutput$ServiceCatalogProvisionedProductDetails' => 'Information about a provisioned service catalog product.
', 'Project$ServiceCatalogProvisionedProductDetails' => NULL, ], ], 'ServiceCatalogProvisioningDetails' => [ 'base' => 'Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
', 'refs' => [ 'CreateProjectInput$ServiceCatalogProvisioningDetails' => '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.
', 'DescribeProjectOutput$ServiceCatalogProvisioningDetails' => 'Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.
', 'Project$ServiceCatalogProvisioningDetails' => NULL, ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'base' => 'Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
', 'refs' => [ 'UpdateProjectInput$ServiceCatalogProvisioningUpdateDetails' => '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.
', ], ], 'SessionExpirationDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$SessionExpirationDurationInSeconds' => 'The session expiration duration in seconds. This value defaults to 43200.
', 'CreatePresignedNotebookInstanceUrlInput$SessionExpirationDurationInSeconds' => 'The duration of the session, in seconds. The default is 12 hours.
', ], ], 'ShadowModeConfig' => [ 'base' => ' 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.
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 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.
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 name and sampling percentage of a shadow variant.
', 'refs' => [ 'ShadowModelVariantConfigList$member' => NULL, ], ], 'ShadowModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'ShadowModeConfig$ShadowModelVariants' => 'List of shadow variant configurations.
', ], ], 'SharingSettings' => [ 'base' => 'Specifies options for sharing SageMaker 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.
Specifies options for sharing SageMaker Studio notebooks.
', ], ], 'ShuffleConfig' => [ 'base' => '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.
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.
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.
', 'DescribeUserProfileResponse$SingleSignOnUserIdentifier' => 'The IAM Identity Center user identifier.
', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$SuccessTopic' => 'Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.
', 'AsyncInferenceNotificationConfig$ErrorTopic' => 'Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.
', 'LabelingJobOutputConfig$SnsTopicArn' => '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.
', 'LabelingJobSnsDataSource$SnsTopicArn' => '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.
', ], ], 'SortActionsBy' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortBy' => 'The property used to sort results. The default value is CreationTime.
The property used to sort results. The default value is CreationTime.
The property used to sort results. The default value is CreationTime.
The field to sort results by. The default is CreationTime.
The field to sort results by. The default is CreationTime.
The field to sort results by. The default is CreationTime.
The field to sort results by. The default is CreationTime.
The property used to sort results. The default value is CreationTime.
The property used to sort results. The default value is CreationTime.
The column by which to sort the listed inference experiments.
', ], ], 'SortLineageGroupsBy' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsRequest$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
The sort order. The default value is Descending.
The sort order for the results. The default is Ascending.
The sort order. The default value is Descending.
The sort order for the results. The default is Ascending.
', 'ListArtifactsRequest$SortOrder' => 'The sort order. The default value is Descending.
The sort order. The default value is Descending.
The sort order for results. The default is Ascending.
The sort order. The default value is Descending.
The sort order for results. The default is Descending.
What direction to sort in.
', 'ListEdgeDeploymentPlansRequest$SortOrder' => 'The direction of the sorting (ascending or descending).
', 'ListEdgePackagingJobsRequest$SortOrder' => 'What direction to sort by.
', 'ListExperimentsRequest$SortOrder' => 'The sort order. The default value is Descending.
An optional value that specifies whether you want the results sorted in Ascending or Descending order.
Sort hub content versions by ascending or descending order.
', 'ListHubContentsRequest$SortOrder' => 'Sort hubs by ascending or descending order.
', 'ListHubsRequest$SortOrder' => 'Sort hubs by ascending or descending order.
', 'ListHumanTaskUisRequest$SortOrder' => 'An optional value that specifies whether you want the results sorted in Ascending or Descending order.
The sort order for results. The default is Ascending.
The direction of sorting (ascending or descending).
', 'ListInferenceRecommendationsJobsRequest$SortOrder' => 'The sort order for the results.
', 'ListLabelingJobsForWorkteamRequest$SortOrder' => 'The sort order for results. The default is Ascending.
The sort order for results. The default is Ascending.
The sort order for the results. The default is Ascending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The sort order for results. The default is Ascending.
The sort order for the results. The default is Ascending.
The sort order for results. The default is Descending.
The sort order, whether Ascending or Descending, of the alert history. The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The field by which to sort results. The default is CreatedTime.
The sort order for results.
', 'ListPipelinesRequest$SortOrder' => 'The sort order for results.
', 'ListProcessingJobsRequest$SortOrder' => 'The sort order for results. The default is Ascending.
The sort order for the results. The default is Ascending.
The sort order. The default value is Descending.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$SortOrder' => 'The sort order for results. The default is Ascending.
The sort order for results. The default is Ascending.
The sort order for results. The default is Descending.
The sort order. The default value is Descending.
The sort order. The default value is Descending.
The sort order for the results. The default is Ascending.
', 'ListWorkforcesRequest$SortOrder' => 'Sort workforces in ascending or descending order.
', 'ListWorkteamsRequest$SortOrder' => 'The sort order for results. The default is Ascending.
The field by which to sort results. The default is CreatedTime.
The field by which to sort results. The default is CreatedTime.
The property used to sort results. The default value is CreationTime.
The property used to sort results. The default value is CreationTime.
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.
', 'refs' => [ 'SourceAlgorithmList$member' => NULL, ], ], 'SourceAlgorithmList' => [ 'base' => NULL, 'refs' => [ 'SourceAlgorithmSpecification$SourceAlgorithms' => 'A list of the algorithms that were used to create a model package.
', ], ], 'SourceAlgorithmSpecification' => [ 'base' => 'A list of algorithms that were used to create a model package.
', 'refs' => [ 'CreateModelPackageInput$SourceAlgorithmSpecification' => 'Details about the algorithm that was used to create the model package.
', 'DescribeModelPackageOutput$SourceAlgorithmSpecification' => 'Details about the algorithm that was used to create the model package.
', 'ModelPackage$SourceAlgorithmSpecification' => 'A list of algorithms that were used to create a model package.
', ], ], 'SourceIpConfig' => [ 'base' => '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 login to their worker portal from an IP address within this range. By default, a workforce isn\'t restricted to specific IP addresses.
', 'refs' => [ 'CreateWorkforceRequest$SourceIpConfig' => NULL, 'UpdateWorkforceRequest$SourceIpConfig' => '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
', 'Workforce$SourceIpConfig' => '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.
', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceType' => 'The source type.
', 'TrialComponentSource$SourceType' => 'The source job type.
', 'TrialSource$SourceType' => 'The source job type.
', ], ], 'SourceUri' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SourceUri' => 'A filter that returns only actions with the specified source URI.
', 'ListArtifactsRequest$SourceUri' => 'A filter that returns only artifacts with the specified source URI.
', 'ListContextsRequest$SourceUri' => 'A filter that returns only contexts with the specified source URI.
', ], ], 'SpaceArn' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceResponse$SpaceArn' => 'The space\'s Amazon Resource Name (ARN).
', 'DescribeSpaceResponse$SpaceArn' => 'The space\'s Amazon Resource Name (ARN).
', 'UpdateSpaceResponse$SpaceArn' => 'The space\'s Amazon Resource Name (ARN).
', ], ], 'SpaceDetails' => [ 'base' => 'The space\'s details.
', 'refs' => [ 'SpaceList$member' => NULL, ], ], 'SpaceList' => [ 'base' => NULL, 'refs' => [ 'ListSpacesResponse$Spaces' => 'The list of spaces.
', ], ], 'SpaceName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$SpaceName' => 'The name of the space.
', 'CreateAppRequest$SpaceName' => 'The name of the space. If this value is not set, then UserProfileName must be set.
The name of the space.
', 'CreateSpaceRequest$SpaceName' => 'The name of the space.
', 'DeleteAppRequest$SpaceName' => 'The name of the space. If this value is not set, then UserProfileName must be set.
The name of the space.
', 'DescribeAppRequest$SpaceName' => 'The name of the space.
', 'DescribeAppResponse$SpaceName' => 'The name of the space. If this value is not set, then UserProfileName must be set.
The name of the space.
', 'DescribeSpaceResponse$SpaceName' => 'The name of the space.
', 'ListAppsRequest$SpaceNameEquals' => 'A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.
A parameter by which to filter the results.
', 'SpaceDetails$SpaceName' => 'The name of the space.
', 'UpdateSpaceRequest$SpaceName' => 'The name of the space.
', ], ], 'SpaceSettings' => [ 'base' => 'A collection of space settings.
', 'refs' => [ 'CreateSpaceRequest$SpaceSettings' => 'A collection of space settings.
', 'DescribeSpaceResponse$SpaceSettings' => 'A collection of space settings.
', 'UpdateSpaceRequest$SpaceSettings' => 'A collection of space settings.
', ], ], 'SpaceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListSpacesRequest$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
The status.
', 'SpaceDetails$Status' => 'The status.
', ], ], 'SpawnRate' => [ 'base' => NULL, 'refs' => [ 'Phase$SpawnRate' => 'Specified how many new users to spawn in a minute.
', ], ], 'SplitType' => [ 'base' => NULL, 'refs' => [ 'TransformInput$SplitType' => '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.
The general status of the current stage.
', ], ], 'Stairs' => [ 'base' => '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.
', 'refs' => [ 'TrafficPattern$Stairs' => 'Defines the stairs traffic pattern.
', ], ], 'StartEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatusDetails' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$StatusDetails' => 'Details from the rule evaluation.
', 'ProfilerRuleEvaluationStatus$StatusDetails' => 'Details from the rule evaluation.
', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'SecondaryStatusTransition$StatusMessage' => '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.
Downloading the training image.
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
The description of the step.
', ], ], 'StepDisplayName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDisplayName' => 'The display name of the step.
', ], ], 'StepName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepName' => 'The name of the step that is executed.
', ], ], 'StepStatus' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepStatus' => 'The status of the step execution.
', ], ], 'StopAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StoppingCondition' => [ 'base' => 'Specifies a limit to how long a model training job or model compilation 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 or compilation job. Use this API to cap model training 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.
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
', 'CreateTrainingJobRequest$StoppingCondition' => '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.
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
', 'DescribeTrainingJobResponse$StoppingCondition' => '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.
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.
', 'TrainingJob$StoppingCondition' => '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.
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.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$FailureReason' => 'if the overall status is Failed, the reason for the failure.
The attributes of the input data that are the input features.
', 'BatchTransformInput$InferenceAttribute' => 'The attribute of the input data that represents the ground truth label.
', 'BatchTransformInput$ProbabilityAttribute' => 'In a classification problem, the attribute that represents the class probability.
', 'CreateModelPackageInput$Domain' => 'The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
', 'CreateModelPackageInput$Task' => '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.
', 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatusMessage' => 'Returns a message describing the job status and error messages.
', 'DescribeEdgePackagingJobResponse$ModelSignature' => 'The signature document of files in the model artifact.
', 'DescribeModelPackageOutput$Domain' => 'The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
', 'DescribeModelPackageOutput$Task' => 'The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
', 'DescribeModelPackageOutput$SamplePayloadUrl' => '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).
', 'DeviceDeploymentSummary$DeviceDeploymentStatusMessage' => 'The detailed error message for the deployoment status result.
', 'EdgeDeploymentStatus$EdgeDeploymentStatusMessage' => 'A detailed message about deployment status in current stage.
', 'EdgeOutputConfig$PresetDeploymentConfig' => 'The 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.
Returns a message describing the status of the deployed resource.
', 'EndpointInput$FeaturesAttribute' => 'The attributes of the input data that are the input features.
', 'EndpointInput$InferenceAttribute' => 'The attribute of the input data that represents the ground truth label.
', 'EndpointInput$ProbabilityAttribute' => 'In a classification problem, the attribute that represents the class probability.
', 'EndpointOutputConfiguration$EndpointName' => 'The name of the endpoint made during a recommendation job.
', 'EndpointOutputConfiguration$VariantName' => 'The name of the production variant (deployed model) made during a recommendation job.
', 'EnvironmentParameter$Key' => 'The environment key suggested by the Amazon SageMaker Inference Recommender.
', 'EnvironmentParameter$ValueType' => 'The value type suggested by the Amazon SageMaker Inference Recommender.
', 'EnvironmentParameter$Value' => 'The value suggested by the Amazon SageMaker Inference Recommender.
', 'IamIdentity$Arn' => 'The Amazon Resource Name (ARN) of the IAM identity.
', 'IamIdentity$PrincipalId' => 'The ID of the principal that assumes the IAM identity.
', 'IamIdentity$SourceIdentity' => 'The person or application which assumes the IAM identity.
', 'InferenceRecommendation$RecommendationId' => 'The recommendation ID which uniquely identifies each recommendation.
', 'ListProcessingJobsRequest$NameContains' => 'A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.
', 'ModelCard$ModelId' => 'The unique name (ID) of the model.
', 'ModelCard$RiskRating' => 'The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
', 'ModelCard$ModelPackageGroupName' => 'The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
', 'ModelDashboardModelCard$ModelId' => 'For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.
', 'ModelDashboardModelCard$RiskRating' => 'A model card\'s risk rating. Can be low, medium, or high.
', 'ModelMetadataSummary$Domain' => 'The machine learning domain of the model.
', 'ModelMetadataSummary$Framework' => 'The machine learning framework of the model.
', 'ModelMetadataSummary$Task' => 'The machine learning task of the model.
', 'ModelMetadataSummary$Model' => 'The name of the model.
', 'ModelMetadataSummary$FrameworkVersion' => 'The framework version of the model.
', 'ModelPackage$Domain' => 'The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
', 'ModelPackage$Task' => 'The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
', 'ModelPackage$SamplePayloadUrl' => '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).
', 'ModelPackageContainerDefinition$Framework' => 'The machine learning framework of the model package container image.
', 'ModelPackageContainerDefinition$NearestModelName' => '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.
if the overall status is Failed, the reason for the failure.
The name for the processing job input.
', 'ProcessingOutput$OutputName' => 'The name for the processing job output.
', 'ProductListings$member' => NULL, 'RStudioServerProDomainSettings$RStudioConnectUrl' => 'A URL pointing to an RStudio Connect server.
', 'RStudioServerProDomainSettings$RStudioPackageManagerUrl' => 'A URL pointing to an RStudio Package Manager server.
', 'RStudioServerProDomainSettingsForUpdate$RStudioConnectUrl' => 'A URL pointing to an RStudio Connect server.
', 'RStudioServerProDomainSettingsForUpdate$RStudioPackageManagerUrl' => 'A URL pointing to an RStudio Package Manager server.
', 'RealTimeInferenceRecommendation$RecommendationId' => 'The recommendation ID which uniquely identifies each recommendation.
', 'RecommendationJobContainerConfig$Domain' => '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.
Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER
The machine learning framework of the container image.
Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN
The framework version of the container image.
', 'RecommendationJobContainerConfig$NearestModelName' => '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 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).
', 'RecommendationJobSupportedContentTypes$member' => NULL, 'RecommendationJobSupportedInstanceTypes$member' => NULL, 'RenderUiTemplateResponse$RenderedContent' => 'A Liquid template that renders the HTML for the worker UI.
', 'RenderingError$Code' => 'A unique identifier for a specific class of errors.
', 'RenderingError$Message' => 'A human-readable message describing the error.
', 'SubscribedWorkteam$SellerName' => 'The name of the vendor in the Amazon Marketplace.
', 'SubscribedWorkteam$ListingId' => 'Marketplace product listing ID.
', 'UserContext$UserProfileArn' => 'The Amazon Resource Name (ARN) of the user\'s profile.
', 'UserContext$UserProfileName' => 'The name of the user\'s profile.
', 'UserContext$DomainId' => 'The domain associated with the user.
', 'Workforce$SubDomain' => 'The subdomain for your OIDC Identity Provider.
', 'Workteam$SubDomain' => 'The URI of the labeling job\'s user interface. Workers open this URI to start labeling your data objects.
', ], ], 'String1024' => [ 'base' => NULL, 'refs' => [ 'ClarifyCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => 'The Amazon S3 URI of baseline constraints file to be used for the drift check.
', 'ClarifyCheckStepMetadata$CalculatedBaselineConstraints' => 'The Amazon S3 URI of the newly calculated baseline constraints file.
', 'ClarifyCheckStepMetadata$ViolationReport' => 'The Amazon S3 URI of the violation report if violations are detected.
', 'CreateDomainResponse$Url' => 'The URL to the created domain.
', 'DescribeDomainResponse$Url' => 'The domain\'s URL.
', 'DomainDetails$Url' => 'The domain\'s URL.
', 'EMRStepMetadata$LogFilePath' => 'The path to the log file where the cluster step\'s failure root cause is recorded.
', 'OutputParameter$Value' => 'The value of the output parameter.
', 'Parameter$Value' => 'The literal value for the parameter.
', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckStatistics' => 'The Amazon S3 URI of the baseline statistics file used for the drift check.
', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => 'The Amazon S3 URI of the baseline constraints file used for the drift check.
', 'QualityCheckStepMetadata$CalculatedBaselineStatistics' => 'The Amazon S3 URI of the newly calculated baseline statistics file.
', 'QualityCheckStepMetadata$CalculatedBaselineConstraints' => 'The Amazon S3 URI of the newly calculated baseline constraints file.
', 'QualityCheckStepMetadata$ViolationReport' => 'The Amazon S3 URI of violation report if violations are detected.
', ], ], 'String128' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRangeValues$member' => NULL, ], ], 'String200' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$Description' => 'A description of the work team.
', 'SubscribedWorkteam$MarketplaceTitle' => 'The title of the service provided by the vendor in the Amazon Marketplace.
', 'SubscribedWorkteam$MarketplaceDescription' => 'The description of the vendor from the Amazon Marketplace.
', 'UpdateWorkteamRequest$Description' => 'An updated description for the work team.
', 'Workteam$Description' => 'A description of the work team.
', ], ], 'String2048' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceUri' => 'The URI of the source.
', 'ArtifactSource$SourceUri' => 'The URI of the source.
', 'ContextSource$SourceUri' => 'The URI of the source.
', ], ], 'String256' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceType' => 'The type of the source.
', 'ActionSource$SourceId' => 'The ID of the source.
', 'ArtifactSourceType$Value' => 'The ID.
', 'ArtifactSummary$ArtifactType' => 'The type of the artifact.
', 'AssociationSummary$SourceType' => 'The source type.
', 'AssociationSummary$DestinationType' => 'The destination type.
', 'CallbackStepMetadata$SqsQueueUrl' => 'The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.
', 'ClarifyCheckStepMetadata$CheckType' => 'The type of the Clarify Check step
', 'ClarifyCheckStepMetadata$ModelPackageGroupName' => 'The model package group name.
', 'ClarifyCheckStepMetadata$CheckJobArn' => 'The Amazon Resource Name (ARN) of the check processing job that was run by this step\'s execution.
', 'ContextSource$SourceType' => 'The type of the source.
', 'ContextSource$SourceId' => 'The ID of the source.
', 'ContextSummary$ContextType' => 'The type of the context.
', 'CreateActionRequest$ActionType' => 'The action type.
', 'CreateArtifactRequest$ArtifactType' => 'The artifact type.
', 'CreateContextRequest$ContextType' => 'The context type.
', 'CreateUserProfileRequest$SingleSignOnUserValue' => '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.
', 'DescribeActionResponse$ActionType' => 'The type of the action.
', 'DescribeArtifactResponse$ArtifactType' => 'The type of the artifact.
', 'DescribeContextResponse$ContextType' => 'The type of the context.
', 'DescribeDomainResponse$SingleSignOnManagedApplicationInstanceId' => 'The IAM Identity Center managed application instance ID.
', 'DescribeUserProfileResponse$SingleSignOnUserValue' => 'The IAM Identity Center user value.
', 'EMRStepMetadata$ClusterId' => 'The identifier of the EMR cluster.
', 'EMRStepMetadata$StepId' => 'The identifier of the EMR cluster step.
', 'EMRStepMetadata$StepName' => 'The name of the EMR cluster step.
', 'LambdaStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.
', 'ListActionsRequest$ActionType' => 'A filter that returns only actions of the specified type.
', 'ListArtifactsRequest$ArtifactType' => 'A filter that returns only artifacts of the specified type.
', 'ListAssociationsRequest$SourceType' => 'A filter that returns only associations with the specified source type.
', 'ListAssociationsRequest$DestinationType' => 'A filter that returns only associations with the specified destination type.
', 'ListContextsRequest$ContextType' => 'A filter that returns only contexts of the specified type.
', 'ListTrialComponentsRequest$SourceArn' => '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 value to filter the model metadata.
', 'ModelStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the created model.
', 'OutputParameter$Name' => 'The name of the output parameter.
', 'QualityCheckStepMetadata$CheckType' => 'The type of the Quality check step.
', 'QualityCheckStepMetadata$ModelPackageGroupName' => 'The model package group name.
', 'QualityCheckStepMetadata$CheckJobArn' => 'The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
', 'QueryProperties$key' => NULL, 'QueryProperties$value' => NULL, 'RegisterModelStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the model package.
', 'SelectedStep$StepName' => 'The name of the pipeline step.
', 'SendPipelineExecutionStepFailureRequest$FailureReason' => 'A message describing why the step failed.
', ], ], 'String3072' => [ 'base' => NULL, 'refs' => [ 'FailStepMetadata$ErrorMessage' => 'A message that you define and then is processed and rendered by the Fail step when the error occurs.
', 'PipelineExecutionSummary$PipelineExecutionFailureReason' => 'A message generated by SageMaker Pipelines describing why the pipeline execution failed.
', ], ], 'String40' => [ 'base' => NULL, 'refs' => [ 'QueryTypes$member' => NULL, 'Vertex$Type' => 'The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...
The type of the action.
', 'CategoricalParameter$Name' => 'The Name of the environment variable.
', 'ModelLatencyThreshold$Percentile' => 'The model latency percentile threshold. For custom load tests, specify the value as P95.
Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.
Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.
The string value of a categorical hyperparameter. If you specify a value for this parameter, you can\'t specify the NumberValue parameter.
The App type that the Lifecycle Configuration is attached to.
', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigAppType' => 'The App type that the Lifecycle Configuration is attached to.
', 'ListStudioLifecycleConfigsRequest$AppTypeEquals' => 'A parameter to search for the App Type to which the Lifecycle Configuration is attached.
', 'StudioLifecycleConfigDetails$StudioLifecycleConfigAppType' => 'The App type to which the Lifecycle Configuration is attached.
', ], ], 'StudioLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => 'The ARN of your created Lifecycle Configuration.
', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => 'The ARN of the Lifecycle Configuration to describe.
', 'LifecycleConfigArns$member' => NULL, 'ResourceSpec$LifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
', 'StudioLifecycleConfigDetails$StudioLifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the Lifecycle Configuration.
', ], ], 'StudioLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigContent' => 'The content of your Studio Lifecycle Configuration script. This content must be base64 encoded.
', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigContent' => 'The content of your Studio Lifecycle Configuration script.
', ], ], 'StudioLifecycleConfigDetails' => [ 'base' => 'Details of the Studio Lifecycle Configuration.
', 'refs' => [ 'StudioLifecycleConfigsList$member' => NULL, ], ], 'StudioLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration to create.
', 'DeleteStudioLifecycleConfigRequest$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration to delete.
', 'DescribeStudioLifecycleConfigRequest$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration to describe.
', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration that is described.
', 'ListStudioLifecycleConfigsRequest$NameContains' => 'A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.
', 'StudioLifecycleConfigDetails$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration.
', ], ], 'StudioLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsRequest$SortBy' => 'The property used to sort results. The default value is CreationTime.
', ], ], 'StudioLifecycleConfigsList' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsResponse$StudioLifecycleConfigs' => 'A list of Lifecycle Configurations and their properties.
', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SubnetId' => 'The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
', 'DescribeNotebookInstanceOutput$SubnetId' => 'The ID of the VPC subnet.
', 'Subnets$member' => NULL, ], ], 'Subnets' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$SubnetIds' => 'The VPC subnets that Studio uses for communication.
', 'DescribeDomainResponse$SubnetIds' => 'The VPC subnets that Studio uses for communication.
', 'VpcConfig$Subnets' => '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.
', ], ], 'SubscribedWorkteam' => [ 'base' => 'Describes a work team of a vendor that does the a labelling job.
', 'refs' => [ 'DescribeSubscribedWorkteamResponse$SubscribedWorkteam' => 'A Workteam instance that contains information about the work team.
An array of Workteam objects, each describing a work team.
Returns true if the work team was successfully deleted; otherwise, returns false.
Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.
', 'refs' => [ 'GetSearchSuggestionsRequest$SuggestionQuery' => 'Limits the property names that are included in the response.
', ], ], 'TableFormat' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreConfig$TableFormat' => 'Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
', ], ], 'TableName' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$TableName' => 'The name of the Glue table.
', ], ], 'TabularJobConfig' => [ 'base' => 'The collection of settings used by an AutoML job V2 for the TABULAR problem type.
Settings used to configure an AutoML job V2 for a tabular problem type (regression, classification).
', ], ], 'TabularResolvedAttributes' => [ 'base' => 'The resolved attributes specific to the TABULAR problem type.
Defines the resolved attributes for the TABULAR problem type.
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.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The tag key. Tag keys must be unique per resource.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'DeleteTagsInput$TagKeys' => 'An array or one or more tag keys to delete.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$Tags' => '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.
', 'AddTagsOutput$Tags' => 'A list of tags associated with the SageMaker resource.
', 'CreateActionRequest$Tags' => 'A list of tags to apply to the action.
', 'CreateAlgorithmInput$Tags' => '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.
', 'CreateAppImageConfigRequest$Tags' => 'A list of tags to apply to the AppImageConfig.
', 'CreateAppRequest$Tags' => 'Each tag consists of a key and an optional value. Tag keys must be unique per resource.
', 'CreateArtifactRequest$Tags' => 'A list of tags to apply to the artifact.
', 'CreateAutoMLJobRequest$Tags' => '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.
', 'CreateAutoMLJobV2Request$Tags' => '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.
', 'CreateCodeRepositoryInput$Tags' => '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.
', 'CreateCompilationJobRequest$Tags' => '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.
', 'CreateContextRequest$Tags' => 'A list of tags to apply to the context.
', 'CreateDataQualityJobDefinitionRequest$Tags' => '(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.
', 'CreateDeviceFleetRequest$Tags' => 'Creates tags for the specified fleet.
', 'CreateDomainRequest$Tags' => '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.
', 'CreateEdgeDeploymentPlanRequest$Tags' => 'List of tags with which to tag the edge deployment plan.
', 'CreateEdgePackagingJobRequest$Tags' => 'Creates tags for the packaging job.
', 'CreateEndpointConfigInput$Tags' => '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.
', 'CreateEndpointInput$Tags' => '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.
', 'CreateExperimentRequest$Tags' => 'A list of tags to associate with the experiment. You can use Search API to search on the tags.
', 'CreateFeatureGroupRequest$Tags' => 'Tags used to identify Features in each FeatureGroup.
An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.
', 'CreateHubRequest$Tags' => 'Any tags to associate with the hub.
', 'CreateHumanTaskUiRequest$Tags' => 'An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.
', 'CreateHyperParameterTuningJobRequest$Tags' => '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.
', 'CreateImageRequest$Tags' => 'A list of tags to apply to the image.
', 'CreateInferenceExperimentRequest$Tags' => '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.
', 'CreateInferenceRecommendationsJobRequest$Tags' => '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.
', 'CreateLabelingJobRequest$Tags' => '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.
', 'CreateModelBiasJobDefinitionRequest$Tags' => '(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.
', 'CreateModelCardRequest$Tags' => 'Key-value pairs used to manage metadata for model cards.
', 'CreateModelExplainabilityJobDefinitionRequest$Tags' => '(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.
', 'CreateModelInput$Tags' => '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.
', 'CreateModelPackageGroupInput$Tags' => '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.
', 'CreateModelPackageInput$Tags' => '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.
', 'CreateModelQualityJobDefinitionRequest$Tags' => '(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.
', 'CreateMonitoringScheduleRequest$Tags' => '(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.
', 'CreateNotebookInstanceInput$Tags' => '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.
', 'CreatePipelineRequest$Tags' => 'A list of tags to apply to the created pipeline.
', 'CreateProcessingJobRequest$Tags' => '(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.
', 'CreateProjectInput$Tags' => '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.
', 'CreateSpaceRequest$Tags' => '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.
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.
', 'CreateTrainingJobRequest$Tags' => '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.
', 'CreateTransformJobRequest$Tags' => '(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.
', 'CreateTrialComponentRequest$Tags' => 'A list of tags to associate with the component. You can use Search API to search on the tags.
', 'CreateTrialRequest$Tags' => 'A list of tags to associate with the trial. You can use Search API to search on the tags.
', 'CreateUserProfileRequest$Tags' => '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.
', 'CreateWorkforceRequest$Tags' => '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.
', 'CreateWorkteamRequest$Tags' => '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.
', 'DescribeLabelingJobResponse$Tags' => '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.
', 'Endpoint$Tags' => '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.
', 'Experiment$Tags' => 'The list of tags that are associated with the experiment. You can use Search API to search on the tags.
', 'FeatureGroup$Tags' => 'Tags used to define a FeatureGroup.
The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
', 'ImportHubContentRequest$Tags' => 'Any tags associated with the hub content.
', 'ListTagsOutput$Tags' => 'An array of Tag objects, each with a tag key and a value.
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.
', 'ModelCard$Tags' => 'Key-value pairs used to manage metadata for the model card.
', 'ModelDashboardModelCard$Tags' => 'The tags associated with a model card.
', 'ModelPackage$Tags' => '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.
', 'ModelPackageGroup$Tags' => '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.
', 'MonitoringSchedule$Tags' => '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.
', 'Pipeline$Tags' => 'A list of tags that apply to the pipeline.
', 'ProcessingJob$Tags' => '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.
', 'Project$Tags' => '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.
', 'RegisterDevicesRequest$Tags' => 'The tags associated with devices.
', 'TrainingJob$Tags' => '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.
', 'TransformJob$Tags' => 'A list of tags associated with the transform job.
', 'Trial$Tags' => 'The list of tags that are associated with the trial. You can use Search API to search on the tags.
', 'TrialComponent$Tags' => 'The list of tags that are associated with the component. You can use Search API to search on the tags.
', 'UpdateProjectInput$Tags' => '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.
', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The tag value.
', ], ], 'TargetAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$TargetAttributeName' => 'The name of the target variable in supervised learning, usually represented by \'y\'.
', 'TabularJobConfig$TargetAttributeName' => 'The name of the target variable in supervised learning, usually represented by \'y\'.
', 'TimeSeriesConfig$TargetAttributeName' => '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.
', ], ], 'TargetDevice' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetDevice' => 'The type of device that the model will run on after the compilation job has completed.
', 'OutputConfig$TargetDevice' => '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.
The name of the column used to provide the class labels. It should not be same as the content column.
', ], ], 'TargetObjectiveMetricValue' => [ 'base' => NULL, 'refs' => [ 'TuningJobCompletionCriteria$TargetObjectiveMetricValue' => 'The value of the objective metric.
', ], ], 'TargetPlatform' => [ 'base' => '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.
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}
The type of accelerator that the model will run on after the compilation job has completed.
', 'TargetPlatform$Accelerator' => '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
The type of architecture that the model will run on after the compilation job has completed.
', 'TargetPlatform$Arch' => '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.
The type of OS that the model will run on after the compilation job has completed.
', 'TargetPlatform$Os' => '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}
The 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.
The variant\'s capacity.
', 'PendingProductionVariantSummary$CurrentInstanceCount' => 'The number of instances associated with the variant.
', 'PendingProductionVariantSummary$DesiredInstanceCount' => '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.
', 'ProductionVariantSummary$CurrentInstanceCount' => 'The number of instances associated with the variant.
', 'ProductionVariantSummary$DesiredInstanceCount' => 'The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
The number of instances of the type specified by InstanceType.
A description of the task for your human workers.
', ], ], 'TaskInput' => [ 'base' => NULL, 'refs' => [ 'RenderableTask$Input' => '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".
Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
', ], ], 'TaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTimeLimitInSeconds' => 'The 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.
A title for the task for your human workers.
', ], ], 'TemplateContent' => [ 'base' => NULL, 'refs' => [ 'UiTemplate$Content' => 'The content of the Liquid template for the worker user interface.
', ], ], 'TemplateContentSha256' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$ContentSha256' => 'The SHA-256 digest of the contents of the template.
', ], ], 'TemplateUrl' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$Url' => 'The URL for the user interface template.
', ], ], 'TensorBoardAppSettings' => [ 'base' => 'The TensorBoard app settings.
', 'refs' => [ 'UserSettings$TensorBoardAppSettings' => 'The TensorBoard app settings.
', ], ], 'TensorBoardOutputConfig' => [ 'base' => 'Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
', 'refs' => [ 'CreateTrainingJobRequest$TensorBoardOutputConfig' => NULL, 'DescribeTrainingJobResponse$TensorBoardOutputConfig' => NULL, 'TrainingJob$TensorBoardOutputConfig' => NULL, ], ], 'TenthFractionsOfACent' => [ 'base' => NULL, 'refs' => [ 'USD$TenthFractionsOfACent' => 'Fractions of a cent, in tenths.
', ], ], 'TerminationWaitInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$TerminationWaitInSeconds' => 'Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.
', ], ], 'TextClassificationJobConfig' => [ 'base' => 'Stores the configuration information for the text classification problem of an AutoML job V2.
', 'refs' => [ 'AutoMLProblemTypeConfig$TextClassificationJobConfig' => 'Settings used to configure an AutoML job V2 for the text classification problem type.
', ], ], 'ThingName' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$IotThingName' => 'The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.
', 'Device$IotThingName' => 'Amazon Web Services Internet of Things (IoT) object name.
', 'DeviceSummary$IotThingName' => 'The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
', ], ], 'TimeSeriesConfig' => [ 'base' => 'The collection of components that defines the time-series.
', 'refs' => [ 'TimeSeriesForecastingJobConfig$TimeSeriesConfig' => 'The collection of components that defines the time-series.
', ], ], 'TimeSeriesForecastingJobConfig' => [ 'base' => 'The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.
The TimeSeriesForecastingJobConfig problem type is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.
Settings used to configure an AutoML job V2 for a time-series forecasting problem type.
The TimeSeriesForecastingJobConfig problem type is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.
Time series forecast settings for the SageMaker Canvas application.
', 'refs' => [ 'CanvasAppSettings$TimeSeriesForecastingSettings' => 'Time series forecast settings for the Canvas application.
', ], ], 'TimeSeriesTransformations' => [ 'base' => '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 transformations modifying specific attributes of the time-series, such as filling strategies for missing values.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$CreationTime' => 'When the action was created.
', 'ActionSummary$LastModifiedTime' => 'When the action was last modified.
', 'AppImageConfigDetails$CreationTime' => 'When the AppImageConfig was created.
', 'AppImageConfigDetails$LastModifiedTime' => 'When the AppImageConfig was last modified.
', 'ArtifactSummary$CreationTime' => 'When the artifact was created.
', 'ArtifactSummary$LastModifiedTime' => 'When the artifact was last modified.
', 'AssociationSummary$CreationTime' => 'When the association was created.
', 'AutoMLCandidate$CreationTime' => 'The creation time.
', 'AutoMLCandidate$EndTime' => 'The end time.
', 'AutoMLCandidate$LastModifiedTime' => 'The last modified time.
', 'AutoMLJobSummary$CreationTime' => 'When the AutoML job was created.
', 'AutoMLJobSummary$EndTime' => 'The end time of an AutoML job.
', 'AutoMLJobSummary$LastModifiedTime' => 'When the AutoML job was last modified.
', 'CompilationJobSummary$CompilationStartTime' => 'The time when the model compilation job started.
', 'CompilationJobSummary$CompilationEndTime' => 'The time when the model compilation job completed.
', 'ContextSummary$CreationTime' => 'When the context was created.
', 'ContextSummary$LastModifiedTime' => 'When the context was last modified.
', 'CreateTrialComponentRequest$StartTime' => 'When the component started.
', 'CreateTrialComponentRequest$EndTime' => 'When the component ended.
', 'DebugRuleEvaluationStatus$LastModifiedTime' => 'Timestamp when the rule evaluation status was last modified.
', 'DeployedImage$ResolutionTime' => 'The date and time when the image path for the model resolved to the ResolvedImage
When the action was created.
', 'DescribeActionResponse$LastModifiedTime' => 'When the action was last modified.
', 'DescribeAppImageConfigResponse$CreationTime' => 'When the AppImageConfig was created.
', 'DescribeAppImageConfigResponse$LastModifiedTime' => 'When the AppImageConfig was last modified.
', 'DescribeAppResponse$LastHealthCheckTimestamp' => 'The timestamp of the last health check.
', 'DescribeAppResponse$LastUserActivityTimestamp' => 'The timestamp of the last user\'s activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.
When the artifact was created.
', 'DescribeArtifactResponse$LastModifiedTime' => 'When the artifact was last modified.
', 'DescribeAutoMLJobResponse$CreationTime' => 'Returns the creation time of the AutoML job.
', 'DescribeAutoMLJobResponse$EndTime' => 'Returns the end time of the AutoML job.
', 'DescribeAutoMLJobResponse$LastModifiedTime' => 'Returns the job\'s last modified time.
', 'DescribeAutoMLJobV2Response$CreationTime' => 'Returns the creation time of the AutoML job V2.
', 'DescribeAutoMLJobV2Response$EndTime' => 'Returns the end time of the AutoML job V2.
', 'DescribeAutoMLJobV2Response$LastModifiedTime' => 'Returns the job\'s last modified time.
', 'DescribeCompilationJobResponse$CompilationStartTime' => '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 successful or stopped job, this is when the job\'s model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
', 'DescribeContextResponse$CreationTime' => 'When the context was created.
', 'DescribeContextResponse$LastModifiedTime' => 'When the context was last modified.
', 'DescribeDataQualityJobDefinitionResponse$CreationTime' => 'The time that the data quality monitoring job definition was created.
', 'DescribeDeviceFleetResponse$CreationTime' => 'Timestamp of when the device fleet was created.
', 'DescribeDeviceFleetResponse$LastModifiedTime' => 'Timestamp of when the device fleet was last updated.
', 'DescribeDeviceResponse$RegistrationTime' => 'The timestamp of the last registration or de-reregistration.
', 'DescribeDeviceResponse$LatestHeartbeat' => 'The last heartbeat received from the device.
', 'DescribeEdgeDeploymentPlanResponse$CreationTime' => 'The time when the edge deployment plan was created.
', 'DescribeEdgeDeploymentPlanResponse$LastModifiedTime' => 'The time when the edge deployment plan was last updated.
', 'DescribeEdgePackagingJobResponse$CreationTime' => 'The timestamp of when the packaging job was created.
', 'DescribeEdgePackagingJobResponse$LastModifiedTime' => 'The timestamp of when the job was last updated.
', 'DescribeEndpointConfigOutput$CreationTime' => 'A timestamp that shows when the endpoint configuration was created.
', 'DescribeEndpointOutput$CreationTime' => 'A timestamp that shows when the endpoint was created.
', 'DescribeEndpointOutput$LastModifiedTime' => 'A timestamp that shows when the endpoint was last modified.
', 'DescribeExperimentResponse$CreationTime' => 'When the experiment was created.
', 'DescribeExperimentResponse$LastModifiedTime' => 'When the experiment was last modified.
', 'DescribeFlowDefinitionResponse$CreationTime' => 'The timestamp when the flow definition was created.
', 'DescribeHubContentResponse$CreationTime' => 'The date and time that hub content was created.
', 'DescribeHubResponse$CreationTime' => 'The date and time that the hub was created.
', 'DescribeHubResponse$LastModifiedTime' => 'The date and time that the hub was last modified.
', 'DescribeHumanTaskUiResponse$CreationTime' => 'The timestamp when the human task user interface was created.
', 'DescribeHyperParameterTuningJobResponse$CreationTime' => 'The date and time that the tuning job started.
', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningEndTime' => 'The date and time that the tuning job ended.
', 'DescribeHyperParameterTuningJobResponse$LastModifiedTime' => 'The date and time that the status of the tuning job was modified.
', 'DescribeImageResponse$CreationTime' => 'When the image was created.
', 'DescribeImageResponse$LastModifiedTime' => 'When the image was last modified.
', 'DescribeImageVersionResponse$CreationTime' => 'When the version was created.
', 'DescribeImageVersionResponse$LastModifiedTime' => 'When the version was last modified.
', 'DescribeInferenceExperimentResponse$CreationTime' => 'The timestamp at which you created the inference experiment.
', 'DescribeInferenceExperimentResponse$CompletionTime' => 'The timestamp at which the inference experiment was completed.
', 'DescribeInferenceExperimentResponse$LastModifiedTime' => 'The timestamp at which you last modified the inference experiment.
', 'DescribeInferenceRecommendationsJobResponse$CompletionTime' => 'A timestamp that shows when the job completed.
', 'DescribeLabelingJobResponse$CreationTime' => 'The date and time that the labeling job was created.
', 'DescribeLabelingJobResponse$LastModifiedTime' => 'The date and time that the labeling job was last updated.
', 'DescribeLineageGroupResponse$CreationTime' => 'The creation time of lineage group.
', 'DescribeLineageGroupResponse$LastModifiedTime' => 'The last modified time of the lineage group.
', 'DescribeModelBiasJobDefinitionResponse$CreationTime' => 'The time at which the model bias job was created.
', 'DescribeModelCardExportJobResponse$CreatedAt' => 'The date and time that the model export job was created.
', 'DescribeModelCardExportJobResponse$LastModifiedAt' => 'The date and time that the model export job was last modified.
', 'DescribeModelCardResponse$CreationTime' => 'The date and time the model card was created.
', 'DescribeModelCardResponse$LastModifiedTime' => 'The date and time the model card was last modified.
', 'DescribeModelExplainabilityJobDefinitionResponse$CreationTime' => 'The time at which the model explainability job was created.
', 'DescribeModelOutput$CreationTime' => 'A timestamp that shows when the model was created.
', 'DescribeModelPackageOutput$LastModifiedTime' => 'The last time that the model package was modified.
', 'DescribeModelQualityJobDefinitionResponse$CreationTime' => 'The time at which the model quality job was created.
', 'DescribeMonitoringScheduleResponse$CreationTime' => 'The time at which the monitoring job was created.
', 'DescribeMonitoringScheduleResponse$LastModifiedTime' => 'The time at which the monitoring job was last modified.
', 'DescribePipelineDefinitionForExecutionResponse$CreationTime' => 'The time when the pipeline was created.
', 'DescribePipelineExecutionResponse$CreationTime' => 'The time when the pipeline execution was created.
', 'DescribePipelineExecutionResponse$LastModifiedTime' => 'The time when the pipeline execution was modified last.
', 'DescribePipelineResponse$CreationTime' => 'The time when the pipeline was created.
', 'DescribePipelineResponse$LastModifiedTime' => 'The time when the pipeline was last modified.
', 'DescribePipelineResponse$LastRunTime' => 'The time when the pipeline was last run.
', 'DescribeProcessingJobResponse$ProcessingEndTime' => 'The time at which the processing job completed.
', 'DescribeProcessingJobResponse$ProcessingStartTime' => 'The time at which the processing job started.
', 'DescribeProcessingJobResponse$LastModifiedTime' => 'The time at which the processing job was last modified.
', 'DescribeProcessingJobResponse$CreationTime' => 'The time at which the processing job was created.
', 'DescribeProjectOutput$CreationTime' => 'The time when the project was created.
', 'DescribeProjectOutput$LastModifiedTime' => 'The timestamp when project was last modified.
', 'DescribeStudioLifecycleConfigResponse$CreationTime' => 'The creation time of the Studio Lifecycle Configuration.
', 'DescribeStudioLifecycleConfigResponse$LastModifiedTime' => 'This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.
', 'DescribeTrainingJobResponse$CreationTime' => 'A timestamp that indicates when the training job was created.
', 'DescribeTrainingJobResponse$TrainingStartTime' => '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 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 modified.
', 'DescribeTransformJobResponse$CreationTime' => 'A timestamp that shows when the transform Job was created.
', 'DescribeTransformJobResponse$TransformStartTime' => '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 billed for the time interval between this time and the value of TransformStartTime.
When the component started.
', 'DescribeTrialComponentResponse$EndTime' => 'When the component ended.
', 'DescribeTrialComponentResponse$CreationTime' => 'When the component was created.
', 'DescribeTrialComponentResponse$LastModifiedTime' => 'When the component was last modified.
', 'DescribeTrialResponse$CreationTime' => 'When the trial was created.
', 'DescribeTrialResponse$LastModifiedTime' => 'When the trial was last modified.
', 'DeviceDeploymentSummary$DeploymentStartTime' => 'The time when the deployment on the device started.
', 'DeviceFleetSummary$CreationTime' => 'Timestamp of when the device fleet was created.
', 'DeviceFleetSummary$LastModifiedTime' => 'Timestamp of when the device fleet was last updated.
', 'DeviceSummary$RegistrationTime' => 'The timestamp of the last registration or de-reregistration.
', 'DeviceSummary$LatestHeartbeat' => 'The last heartbeat received from the device.
', 'EdgeDeploymentPlanSummary$CreationTime' => 'The time when the edge deployment plan was created.
', 'EdgeDeploymentPlanSummary$LastModifiedTime' => 'The time when the edge deployment plan was last updated.
', 'EdgeDeploymentStatus$EdgeDeploymentStageStartTime' => 'The time when the deployment API started.
', 'EdgeModel$LatestSampleTime' => 'The timestamp of the last data sample taken.
', 'EdgeModel$LatestInference' => 'The timestamp of the last inference that was made.
', 'EdgePackagingJobSummary$CreationTime' => 'The timestamp of when the job was created.
', 'EdgePackagingJobSummary$LastModifiedTime' => 'The timestamp of when the edge packaging job was last updated.
', 'Endpoint$CreationTime' => 'The time that the endpoint was created.
', 'Endpoint$LastModifiedTime' => 'The last time the endpoint was modified.
', 'EndpointConfigSummary$CreationTime' => 'A timestamp that shows when the endpoint configuration was created.
', 'EndpointSummary$CreationTime' => 'A timestamp that shows when the endpoint was created.
', 'EndpointSummary$LastModifiedTime' => 'A timestamp that shows when the endpoint was last modified.
', 'Experiment$CreationTime' => 'When the experiment was created.
', 'Experiment$LastModifiedTime' => 'When the experiment was last modified.
', 'ExperimentSummary$CreationTime' => 'When the experiment was created.
', 'ExperimentSummary$LastModifiedTime' => 'When the experiment was last modified.
', 'FeatureGroupSummary$CreationTime' => 'A timestamp indicating the time of creation time of the FeatureGroup.
The timestamp when SageMaker created the flow definition.
', 'GetDeviceFleetReportResponse$ReportGenerated' => 'Timestamp of when the report was generated.
', 'HubContentInfo$CreationTime' => 'The date and time that the hub content was created.
', 'HubInfo$CreationTime' => 'The date and time that the hub was created.
', 'HubInfo$LastModifiedTime' => 'The date and time that the hub was last modified.
', 'HumanTaskUiSummary$CreationTime' => 'A timestamp when SageMaker created the human task user interface.
', 'HyperParameterTrainingJobSummary$CreationTime' => 'The date and time that the training job was created.
', 'HyperParameterTrainingJobSummary$TrainingStartTime' => 'The date and time that the training job started.
', 'HyperParameterTrainingJobSummary$TrainingEndTime' => '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 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.
', 'HyperParameterTuningJobSearchEntity$CreationTime' => 'The time that a hyperparameter tuning job was created.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningEndTime' => 'The time that a hyperparameter tuning job ended.
', 'HyperParameterTuningJobSearchEntity$LastModifiedTime' => 'The time that a hyperparameter tuning job was last modified.
', 'HyperParameterTuningJobSummary$CreationTime' => 'The date and time that the tuning job was created.
', 'HyperParameterTuningJobSummary$HyperParameterTuningEndTime' => 'The date and time that the tuning job ended.
', 'HyperParameterTuningJobSummary$LastModifiedTime' => 'The date and time that the tuning job was modified.
', 'Image$CreationTime' => 'When the image was created.
', 'Image$LastModifiedTime' => 'When the image was last modified.
', 'ImageVersion$CreationTime' => 'When the version was created.
', 'ImageVersion$LastModifiedTime' => 'When the version was last modified.
', 'InferenceExperimentSchedule$StartTime' => 'The timestamp at which the inference experiment started or will start.
', 'InferenceExperimentSchedule$EndTime' => 'The timestamp at which the inference experiment ended or will end.
', 'InferenceExperimentSummary$CreationTime' => 'The timestamp at which the inference experiment was created.
', 'InferenceExperimentSummary$CompletionTime' => 'The timestamp at which the inference experiment was completed.
', 'InferenceExperimentSummary$LastModifiedTime' => 'The timestamp when you last modified the inference experiment.
', 'InferenceRecommendationsJob$CompletionTime' => 'A timestamp that shows when the job completed.
', 'LabelingJobForWorkteamSummary$CreationTime' => 'The date and time that the labeling job was created.
', 'LabelingJobSummary$CreationTime' => 'The date and time that the job was created (timestamp).
', 'LabelingJobSummary$LastModifiedTime' => 'The date and time that the job was last modified (timestamp).
', 'LineageGroupSummary$CreationTime' => 'The creation time of the lineage group summary.
', 'LineageGroupSummary$LastModifiedTime' => 'The last modified time of the lineage group summary.
', 'ListActionsRequest$CreatedAfter' => 'A filter that returns only actions created on or after the specified time.
', 'ListActionsRequest$CreatedBefore' => 'A filter that returns only actions created on or before the specified time.
', 'ListAppImageConfigsRequest$CreationTimeBefore' => 'A filter that returns only AppImageConfigs created on or before the specified time.
', 'ListAppImageConfigsRequest$CreationTimeAfter' => 'A filter that returns only AppImageConfigs created on or after the specified time.
', 'ListAppImageConfigsRequest$ModifiedTimeBefore' => 'A filter that returns only AppImageConfigs modified on or before the specified time.
', 'ListAppImageConfigsRequest$ModifiedTimeAfter' => 'A filter that returns only AppImageConfigs modified on or after the specified time.
', 'ListArtifactsRequest$CreatedAfter' => 'A filter that returns only artifacts created on or after the specified time.
', 'ListArtifactsRequest$CreatedBefore' => 'A filter that returns only artifacts created on or before the specified time.
', 'ListAssociationsRequest$CreatedAfter' => 'A filter that returns only associations created on or after the specified time.
', 'ListAssociationsRequest$CreatedBefore' => 'A filter that returns only associations created on or before the specified time.
', 'ListAutoMLJobsRequest$CreationTimeAfter' => 'Request a list of jobs, using a filter for time.
', 'ListAutoMLJobsRequest$CreationTimeBefore' => 'Request a list of jobs, using a filter for time.
', 'ListAutoMLJobsRequest$LastModifiedTimeAfter' => 'Request a list of jobs, using a filter for time.
', 'ListAutoMLJobsRequest$LastModifiedTimeBefore' => 'Request a list of jobs, using a filter for time.
', 'ListCodeRepositoriesInput$LastModifiedTimeAfter' => 'A filter that returns only Git repositories that were last modified after the specified time.
', 'ListCodeRepositoriesInput$LastModifiedTimeBefore' => 'A filter that returns only Git repositories that were last modified before the specified time.
', 'ListContextsRequest$CreatedAfter' => 'A filter that returns only contexts created on or after the specified time.
', 'ListContextsRequest$CreatedBefore' => 'A filter that returns only contexts created on or before the specified time.
', 'ListDataQualityJobDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only data quality monitoring job definitions created before the specified time.
', 'ListDataQualityJobDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only data quality monitoring job definitions created after the specified time.
', 'ListDeviceFleetsRequest$CreationTimeAfter' => 'Filter fleets where packaging job was created after specified time.
', 'ListDeviceFleetsRequest$CreationTimeBefore' => 'Filter fleets where the edge packaging job was created before specified time.
', 'ListDeviceFleetsRequest$LastModifiedTimeAfter' => 'Select fleets where the job was updated after X
', 'ListDeviceFleetsRequest$LastModifiedTimeBefore' => 'Select fleets where the job was updated before X
', 'ListDevicesRequest$LatestHeartbeatAfter' => 'Select fleets where the job was updated after X
', 'ListEdgeDeploymentPlansRequest$CreationTimeAfter' => 'Selects edge deployment plans created after this time.
', 'ListEdgeDeploymentPlansRequest$CreationTimeBefore' => 'Selects edge deployment plans created before this time.
', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeAfter' => 'Selects edge deployment plans that were last updated after this time.
', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeBefore' => 'Selects edge deployment plans that were last updated before this time.
', 'ListEdgePackagingJobsRequest$CreationTimeAfter' => 'Select jobs where the job was created after specified time.
', 'ListEdgePackagingJobsRequest$CreationTimeBefore' => 'Select jobs where the job was created before specified time.
', 'ListEdgePackagingJobsRequest$LastModifiedTimeAfter' => 'Select jobs where the job was updated after specified time.
', 'ListEdgePackagingJobsRequest$LastModifiedTimeBefore' => 'Select jobs where the job was updated before specified time.
', 'ListEndpointConfigsInput$CreationTimeBefore' => 'A filter that returns only endpoint configurations created before the specified time (timestamp).
', 'ListEndpointConfigsInput$CreationTimeAfter' => 'A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).
', 'ListEndpointsInput$CreationTimeBefore' => 'A filter that returns only endpoints that were created before the specified time (timestamp).
', 'ListEndpointsInput$CreationTimeAfter' => 'A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
', 'ListEndpointsInput$LastModifiedTimeBefore' => 'A filter that returns only endpoints that were modified before the specified timestamp.
', 'ListEndpointsInput$LastModifiedTimeAfter' => 'A filter that returns only endpoints that were modified after the specified timestamp.
', 'ListExperimentsRequest$CreatedAfter' => 'A filter that returns only experiments created after the specified time.
', 'ListExperimentsRequest$CreatedBefore' => 'A filter that returns only experiments created before the specified time.
', 'ListFlowDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
', 'ListFlowDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only flow definitions that were created before the specified timestamp.
', 'ListHubContentVersionsRequest$CreationTimeBefore' => 'Only list hub content versions that were created before the time specified.
', 'ListHubContentVersionsRequest$CreationTimeAfter' => 'Only list hub content versions that were created after the time specified.
', 'ListHubContentsRequest$CreationTimeBefore' => 'Only list hub content that was created before the time specified.
', 'ListHubContentsRequest$CreationTimeAfter' => 'Only list hub content that was created after the time specified.
', 'ListHubsRequest$CreationTimeBefore' => 'Only list hubs that were created before the time specified.
', 'ListHubsRequest$CreationTimeAfter' => 'Only list hubs that were created after the time specified.
', 'ListHubsRequest$LastModifiedTimeBefore' => 'Only list hubs that were last modified before the time specified.
', 'ListHubsRequest$LastModifiedTimeAfter' => 'Only list hubs that were last modified after the time specified.
', 'ListHumanTaskUisRequest$CreationTimeAfter' => 'A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
', 'ListHumanTaskUisRequest$CreationTimeBefore' => 'A filter that returns only human task user interfaces that were created before the specified timestamp.
', 'ListHyperParameterTuningJobsRequest$CreationTimeAfter' => 'A filter that returns only tuning jobs that were created after the specified time.
', 'ListHyperParameterTuningJobsRequest$CreationTimeBefore' => 'A filter that returns only tuning jobs that were created before the specified time.
', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only tuning jobs that were modified after the specified time.
', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only tuning jobs that were modified before the specified time.
', 'ListImageVersionsRequest$CreationTimeAfter' => 'A filter that returns only versions created on or after the specified time.
', 'ListImageVersionsRequest$CreationTimeBefore' => 'A filter that returns only versions created on or before the specified time.
', 'ListImageVersionsRequest$LastModifiedTimeAfter' => 'A filter that returns only versions modified on or after the specified time.
', 'ListImageVersionsRequest$LastModifiedTimeBefore' => 'A filter that returns only versions modified on or before the specified time.
', 'ListImagesRequest$CreationTimeAfter' => 'A filter that returns only images created on or after the specified time.
', 'ListImagesRequest$CreationTimeBefore' => 'A filter that returns only images created on or before the specified time.
', 'ListImagesRequest$LastModifiedTimeAfter' => 'A filter that returns only images modified on or after the specified time.
', 'ListImagesRequest$LastModifiedTimeBefore' => 'A filter that returns only images modified on or before the specified time.
', 'ListInferenceExperimentsRequest$CreationTimeAfter' => 'Selects inference experiments which were created after this timestamp.
', 'ListInferenceExperimentsRequest$CreationTimeBefore' => 'Selects inference experiments which were created before this timestamp.
', 'ListInferenceExperimentsRequest$LastModifiedTimeAfter' => 'Selects inference experiments which were last modified after this timestamp.
', 'ListInferenceExperimentsRequest$LastModifiedTimeBefore' => 'Selects inference experiments which were last modified before this timestamp.
', 'ListLabelingJobsForWorkteamRequest$CreationTimeAfter' => 'A filter that returns only labeling jobs created after the specified time (timestamp).
', 'ListLabelingJobsForWorkteamRequest$CreationTimeBefore' => 'A filter that returns only labeling jobs created before the specified time (timestamp).
', 'ListLabelingJobsRequest$CreationTimeAfter' => 'A filter that returns only labeling jobs created after the specified time (timestamp).
', 'ListLabelingJobsRequest$CreationTimeBefore' => 'A filter that returns only labeling jobs created before the specified time (timestamp).
', 'ListLabelingJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only labeling jobs modified after the specified time (timestamp).
', 'ListLabelingJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only labeling jobs modified before the specified time (timestamp).
', 'ListLineageGroupsRequest$CreatedAfter' => 'A timestamp to filter against lineage groups created after a certain point in time.
', 'ListLineageGroupsRequest$CreatedBefore' => 'A timestamp to filter against lineage groups created before a certain point in time.
', 'ListModelBiasJobDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only model bias jobs created before a specified time.
', 'ListModelBiasJobDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only model bias jobs created after a specified time.
', 'ListModelCardExportJobsRequest$CreationTimeAfter' => 'Only list model card export jobs that were created after the time specified.
', 'ListModelCardExportJobsRequest$CreationTimeBefore' => 'Only list model card export jobs that were created before the time specified.
', 'ListModelCardVersionsRequest$CreationTimeAfter' => 'Only list model card versions that were created after the time specified.
', 'ListModelCardVersionsRequest$CreationTimeBefore' => 'Only list model card versions that were created before the time specified.
', 'ListModelCardsRequest$CreationTimeAfter' => 'Only list model cards that were created after the time specified.
', 'ListModelCardsRequest$CreationTimeBefore' => 'Only list model cards that were created before the time specified.
', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only model explainability jobs created before a specified time.
', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only model explainability jobs created after a specified time.
', 'ListModelQualityJobDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only model quality monitoring job definitions created before the specified time.
', 'ListModelQualityJobDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only model quality monitoring job definitions created after the specified time.
', 'ListModelsInput$CreationTimeBefore' => 'A filter that returns only models created before the specified time (timestamp).
', 'ListModelsInput$CreationTimeAfter' => 'A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
', 'ListMonitoringAlertHistoryRequest$CreationTimeBefore' => 'A filter that returns only alerts created on or before the specified time.
', 'ListMonitoringAlertHistoryRequest$CreationTimeAfter' => 'A filter that returns only alerts created on or after the specified time.
', 'ListMonitoringExecutionsRequest$ScheduledTimeBefore' => 'Filter for jobs scheduled before a specified time.
', 'ListMonitoringExecutionsRequest$ScheduledTimeAfter' => 'Filter for jobs scheduled after a specified time.
', 'ListMonitoringExecutionsRequest$CreationTimeBefore' => 'A filter that returns only jobs created before a specified time.
', 'ListMonitoringExecutionsRequest$CreationTimeAfter' => 'A filter that returns only jobs created after a specified time.
', 'ListMonitoringExecutionsRequest$LastModifiedTimeBefore' => 'A filter that returns only jobs modified after a specified time.
', 'ListMonitoringExecutionsRequest$LastModifiedTimeAfter' => 'A filter that returns only jobs modified before a specified time.
', 'ListMonitoringSchedulesRequest$CreationTimeBefore' => 'A filter that returns only monitoring schedules created before a specified time.
', 'ListMonitoringSchedulesRequest$CreationTimeAfter' => 'A filter that returns only monitoring schedules created after a specified time.
', 'ListMonitoringSchedulesRequest$LastModifiedTimeBefore' => 'A filter that returns only monitoring schedules modified before a specified time.
', 'ListMonitoringSchedulesRequest$LastModifiedTimeAfter' => 'A filter that returns only monitoring schedules modified after a specified time.
', 'ListPipelineExecutionsRequest$CreatedAfter' => 'A filter that returns the pipeline executions that were created after a specified time.
', 'ListPipelineExecutionsRequest$CreatedBefore' => 'A filter that returns the pipeline executions that were created before a specified time.
', 'ListPipelinesRequest$CreatedAfter' => 'A filter that returns the pipelines that were created after a specified time.
', 'ListPipelinesRequest$CreatedBefore' => 'A filter that returns the pipelines that were created before a specified time.
', 'ListProcessingJobsRequest$CreationTimeAfter' => 'A filter that returns only processing jobs created after the specified time.
', 'ListProcessingJobsRequest$CreationTimeBefore' => 'A filter that returns only processing jobs created after the specified time.
', 'ListProcessingJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only processing jobs modified after the specified time.
', 'ListProcessingJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only processing jobs modified before the specified time.
', 'ListProjectsInput$CreationTimeAfter' => 'A filter that returns the projects that were created after a specified time.
', 'ListProjectsInput$CreationTimeBefore' => 'A filter that returns the projects that were created before a specified time.
', 'ListResourceCatalogsRequest$CreationTimeAfter' => ' Use this parameter to search for ResourceCatalogs created after a specific date and time.
Use this parameter to search for ResourceCatalogs created before a specific date and time.
A filter that returns only Lifecycle Configurations created on or before the specified time.
', 'ListStudioLifecycleConfigsRequest$CreationTimeAfter' => 'A filter that returns only Lifecycle Configurations created on or after the specified time.
', 'ListStudioLifecycleConfigsRequest$ModifiedTimeBefore' => 'A filter that returns only Lifecycle Configurations modified before the specified time.
', 'ListStudioLifecycleConfigsRequest$ModifiedTimeAfter' => 'A filter that returns only Lifecycle Configurations modified after the specified time.
', 'ListTrainingJobsRequest$CreationTimeAfter' => 'A filter that returns only training jobs created after the specified time (timestamp).
', 'ListTrainingJobsRequest$CreationTimeBefore' => 'A filter that returns only training jobs created before the specified time (timestamp).
', 'ListTrainingJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only training jobs modified after the specified time (timestamp).
', 'ListTrainingJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only training jobs modified before the specified time (timestamp).
', 'ListTransformJobsRequest$CreationTimeAfter' => 'A filter that returns only transform jobs created after the specified time.
', 'ListTransformJobsRequest$CreationTimeBefore' => 'A filter that returns only transform jobs created before the specified time.
', 'ListTransformJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only transform jobs modified after the specified time.
', 'ListTransformJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only transform jobs modified before the specified time.
', 'ListTrialComponentsRequest$CreatedAfter' => 'A filter that returns only components created after the specified time.
', 'ListTrialComponentsRequest$CreatedBefore' => 'A filter that returns only components created before the specified time.
', 'ListTrialsRequest$CreatedAfter' => 'A filter that returns only trials created after the specified time.
', 'ListTrialsRequest$CreatedBefore' => 'A filter that returns only trials created before the specified time.
', 'MetricData$Timestamp' => 'The date and time that the algorithm emitted the metric.
', 'Model$CreationTime' => 'A timestamp that indicates when the model was created.
', 'ModelCard$CreationTime' => 'The date and time that the model card was created.
', 'ModelCard$LastModifiedTime' => 'The date and time that the model card was last modified.
', 'ModelCardExportJobSummary$CreatedAt' => 'The date and time that the model card export job was created.
', 'ModelCardExportJobSummary$LastModifiedAt' => 'The date and time that the model card export job was last modified..
', 'ModelCardSummary$CreationTime' => 'The date and time that the model card was created.
', 'ModelCardSummary$LastModifiedTime' => 'The date and time that the model card was last modified.
', 'ModelCardVersionSummary$CreationTime' => 'The date and time that the model card version was created.
', 'ModelCardVersionSummary$LastModifiedTime' => 'The time date and time that the model card version was last modified.
', 'ModelDashboardEndpoint$CreationTime' => 'A timestamp that indicates when the endpoint was created.
', 'ModelDashboardEndpoint$LastModifiedTime' => 'The last time the endpoint was modified.
', 'ModelDashboardModelCard$CreationTime' => 'A timestamp that indicates when the model card was created.
', 'ModelDashboardModelCard$LastModifiedTime' => 'A timestamp that indicates when the model card was last updated.
', 'ModelDashboardMonitoringSchedule$CreationTime' => 'A timestamp that indicates when the monitoring schedule was created.
', 'ModelDashboardMonitoringSchedule$LastModifiedTime' => 'A timestamp that indicates when the monitoring schedule was last updated.
', 'ModelPackage$LastModifiedTime' => 'The last time the model package was modified.
', 'ModelSummary$CreationTime' => 'A timestamp that indicates when the model was created.
', 'MonitoringAlertHistorySummary$CreationTime' => '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.
A timestamp that indicates when a monitor alert was created.
', 'MonitoringAlertSummary$LastModifiedTime' => 'A timestamp that indicates when a monitor alert was last updated.
', 'MonitoringExecutionSummary$ScheduledTime' => 'The time the monitoring job was scheduled.
', 'MonitoringExecutionSummary$CreationTime' => 'The time at which the monitoring job was created.
', 'MonitoringExecutionSummary$LastModifiedTime' => 'A timestamp that indicates the last time the monitoring job was modified.
', 'MonitoringJobDefinitionSummary$CreationTime' => 'The time that the monitoring job was created.
', 'MonitoringSchedule$CreationTime' => 'The time that the monitoring schedule was created.
', 'MonitoringSchedule$LastModifiedTime' => 'The last time the monitoring schedule was changed.
', 'MonitoringScheduleSummary$CreationTime' => 'The creation time of the monitoring schedule.
', 'MonitoringScheduleSummary$LastModifiedTime' => 'The last time the monitoring schedule was modified.
', 'PendingDeploymentSummary$StartTime' => 'The start time of the deployment.
', 'Pipeline$CreationTime' => 'The creation time of the pipeline.
', 'Pipeline$LastModifiedTime' => 'The time that the pipeline was last modified.
', 'Pipeline$LastRunTime' => 'The time when the pipeline was last run.
', 'PipelineExecution$CreationTime' => 'The creation time of the pipeline execution.
', 'PipelineExecution$LastModifiedTime' => 'The time that the pipeline execution was last modified.
', 'PipelineExecutionStep$StartTime' => 'The time that the step started executing.
', 'PipelineExecutionStep$EndTime' => 'The time that the step stopped executing.
', 'PipelineExecutionSummary$StartTime' => 'The start time of the pipeline execution.
', 'PipelineSummary$CreationTime' => 'The creation time of the pipeline.
', 'PipelineSummary$LastModifiedTime' => 'The time that the pipeline was last modified.
', 'PipelineSummary$LastExecutionTime' => 'The last time that a pipeline execution began.
', 'ProcessingJob$ProcessingEndTime' => 'The time that the processing job ended.
', 'ProcessingJob$ProcessingStartTime' => 'The time that the processing job started.
', 'ProcessingJob$LastModifiedTime' => 'The time the processing job was last modified.
', 'ProcessingJob$CreationTime' => 'The time the processing job was created.
', 'ProcessingJobSummary$CreationTime' => 'The time at which the processing job was created.
', 'ProcessingJobSummary$ProcessingEndTime' => 'The time at which the processing job completed.
', 'ProcessingJobSummary$LastModifiedTime' => 'A timestamp that indicates the last time the processing job was modified.
', 'ProductionVariantStatus$StartTime' => 'The start time of the current status change.
', 'ProfilerRuleEvaluationStatus$LastModifiedTime' => 'Timestamp when the rule evaluation status was last modified.
', 'Project$CreationTime' => 'A timestamp specifying when the project was created.
', 'Project$LastModifiedTime' => 'A timestamp container for when the project was last modified.
', 'ProjectSummary$CreationTime' => 'The time that the project was created.
', 'QueryFilters$CreatedBefore' => 'Filter the lineage entities connected to the StartArn(s) by created date.
Filter the lineage entities connected to the StartArn(s) after the create date.
Filter the lineage entities connected to the StartArn(s) before the last modified date.
Filter the lineage entities connected to the StartArn(s) after the last modified date.
The time the ResourceCatalog was created.
A timestamp that shows when the training job transitioned to the current secondary status state.
', 'SecondaryStatusTransition$EndTime' => '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.
', 'StudioLifecycleConfigDetails$CreationTime' => 'The creation time of the Studio Lifecycle Configuration.
', 'StudioLifecycleConfigDetails$LastModifiedTime' => 'This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.
', 'TrainingJob$CreationTime' => 'A timestamp that indicates when the training job was created.
', 'TrainingJob$TrainingStartTime' => '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 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 modified.
', 'TrainingJobSummary$CreationTime' => 'A timestamp that shows when the training job was created.
', 'TrainingJobSummary$TrainingEndTime' => '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).
Timestamp when the training job was last modified.
', 'TransformJob$CreationTime' => 'A timestamp that shows when the transform Job was created.
', 'TransformJob$TransformStartTime' => '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 billed for the time interval between this time and the value of TransformStartTime.
A timestamp that shows when the transform Job was created.
', 'TransformJobSummary$TransformEndTime' => '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.
', 'TransformJobSummary$LastModifiedTime' => 'Indicates when the transform job was last modified.
', 'Trial$CreationTime' => 'When the trial was created.
', 'Trial$LastModifiedTime' => 'Who last modified the trial.
', 'TrialComponent$StartTime' => 'When the component started.
', 'TrialComponent$EndTime' => 'When the component ended.
', 'TrialComponent$CreationTime' => 'When the component was created.
', 'TrialComponent$LastModifiedTime' => 'When the component was last modified.
', 'TrialComponentMetricSummary$TimeStamp' => 'When the metric was last updated.
', 'TrialComponentSimpleSummary$CreationTime' => 'When the component was created.
', 'TrialComponentSummary$StartTime' => 'When the component started.
', 'TrialComponentSummary$EndTime' => 'When the component ended.
', 'TrialComponentSummary$CreationTime' => 'When the component was created.
', 'TrialComponentSummary$LastModifiedTime' => 'When the component was last modified.
', 'TrialSummary$CreationTime' => 'When the trial was created.
', 'TrialSummary$LastModifiedTime' => 'When the trial was last modified.
', 'UpdateTrialComponentRequest$StartTime' => 'When the component started.
', 'UpdateTrialComponentRequest$EndTime' => 'When the component ended.
', 'Workforce$LastUpdatedDate' => '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.
', 'Workforce$CreateDate' => 'The date that the workforce is created.
', 'Workteam$CreateDate' => 'The date and time that the work team was created (timestamp).
', 'Workteam$LastUpdatedDate' => 'The date and time that the work team was last updated (timestamp).
', ], ], 'TimestampAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$TimestampAttributeName' => 'The name of the column indicating a point in time at which the target value of a given item is recorded.
', ], ], 'TrafficDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Phase$DurationInSeconds' => '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.
Defines how long each traffic step should be.
', ], ], 'TrafficPattern' => [ 'base' => 'Defines the traffic pattern of the load test.
', 'refs' => [ 'RecommendationJobInputConfig$TrafficPattern' => 'Specifies the traffic pattern of the job.
', ], ], 'TrafficRoutingConfig' => [ 'base' => 'Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.
', 'refs' => [ 'BlueGreenUpdatePolicy$TrafficRoutingConfiguration' => 'Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.
', ], ], 'TrafficRoutingConfigType' => [ 'base' => NULL, 'refs' => [ 'TrafficRoutingConfig$Type' => '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.
Defines the traffic patterns. Choose either PHASES or STAIRS.
The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.
', ], ], 'TrainingContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerEntrypoint' => '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.
', ], ], 'TrainingContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerEntrypoint$member' => NULL, ], ], 'TrainingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$key' => NULL, ], ], 'TrainingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$Environment' => 'The environment variables to set in the Docker container.
', 'DescribeTrainingJobResponse$Environment' => 'The environment variables to set in the Docker container.
', 'TrainingJob$Environment' => 'The environment variables to set in the Docker container.
', ], ], 'TrainingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$value' => NULL, ], ], 'TrainingImageConfig' => [ 'base' => 'The configuration to use an image from a private Docker registry for a training job.
', 'refs' => [ 'AlgorithmSpecification$TrainingImageConfig' => 'The configuration to use an image from a private Docker registry for a training job.
', ], ], 'TrainingInputMode' => [ 'base' => '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.
(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.
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 number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
Specifies the number of instances of the instance group.
', 'ResourceConfig$InstanceCount' => 'The number of ML compute instances to use. For distributed training, provide a value greater than 1.
', ], ], 'TrainingInstanceType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceType' => '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.
', 'HyperParameterTuningResourceConfig$InstanceType' => 'The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.
', 'InstanceGroup$InstanceType' => 'Specifies the instance type of the instance group.
', 'ResourceConfig$InstanceType' => 'The 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.
A list of the instance types that this algorithm can use for training.
', ], ], 'TrainingJob' => [ 'base' => 'Contains information about a training job.
', 'refs' => [ 'SearchRecord$TrainingJob' => 'The properties of a training job.
', 'TrialComponentSourceDetail$TrainingJob' => 'Information about a training job that\'s the source of a trial component.
', ], ], 'TrainingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobResponse$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'DescribeProcessingJobResponse$TrainingJobArn' => 'The ARN of a training job associated with this processing job.
', 'DescribeTrainingJobResponse$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'HyperParameterTrainingJobSummary$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'ProcessingJob$TrainingJobArn' => 'The ARN of the training job associated with this processing job.
', 'TrainingJob$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'TrainingJobStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the training job that was run by this step execution.
', 'TrainingJobSummary$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'UpdateTrainingJobResponse$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', ], ], 'TrainingJobDefinition' => [ 'base' => 'Defines the input needed to run a training job using the algorithm.
', 'refs' => [ 'AlgorithmValidationProfile$TrainingJobDefinition' => 'The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.
Specifies 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.
The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
', 'DescribeTrainingJobRequest$TrainingJobName' => 'The name of the training job.
', 'DescribeTrainingJobResponse$TrainingJobName' => 'Name of the model training job.
', 'HyperParameterTrainingJobSummary$TrainingJobName' => 'The name of the training job.
', 'StopTrainingJobRequest$TrainingJobName' => 'The name of the training job to stop.
', 'TrainingJob$TrainingJobName' => 'The name of the training job.
', 'TrainingJobSummary$TrainingJobName' => 'The name of the training job that you want a summary for.
', 'UpdateTrainingJobRequest$TrainingJobName' => 'The name of a training job to update the Debugger profiling configuration.
', 'WarmPoolStatus$ReusedByJob' => 'The name of the matching training job that reused the warm pool.
', ], ], 'TrainingJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobRequest$SortBy' => '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.
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.
The status of the training job.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$StatusEquals' => 'A filter that returns only training jobs with the specified status.
', 'ListTrainingJobsRequest$StatusEquals' => 'A filter that retrieves only training jobs with a specific status.
', 'TrainingJob$TrainingJobStatus' => '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.
The status of the training job.
', ], ], 'TrainingJobStatusCounter' => [ 'base' => NULL, 'refs' => [ 'TrainingJobStatusCounters$Completed' => 'The number of completed training jobs launched by the hyperparameter tuning job.
', 'TrainingJobStatusCounters$InProgress' => 'The number of in-progress training jobs launched by a hyperparameter tuning job.
', 'TrainingJobStatusCounters$RetryableError' => '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.
', 'TrainingJobStatusCounters$NonRetryableError' => '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.
', 'TrainingJobStatusCounters$Stopped' => 'The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
', ], ], 'TrainingJobStatusCounters' => [ 'base' => 'The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters' => 'The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
', 'HyperParameterTuningJobSearchEntity$TrainingJobStatusCounters' => NULL, 'HyperParameterTuningJobSummary$TrainingJobStatusCounters' => 'The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
', ], ], 'TrainingJobStepMetadata' => [ 'base' => 'Metadata for a training job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$TrainingJob' => 'The Amazon Resource Name (ARN) of the training job that was run by this step execution.
', ], ], 'TrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsResponse$TrainingJobSummaries' => 'An array of TrainingJobSummary objects, each listing a training job.
Provides summary information about a training job.
', 'refs' => [ 'TrainingJobSummaries$member' => NULL, ], ], 'TrainingRepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAccessMode' => '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.
', 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAuthConfig' => 'An object containing authentication information for a private Docker registry containing your training images.
', ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'TrainingRepositoryAuthConfig$TrainingRepositoryCredentialsProviderArn' => 'The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access credentials to your private Docker registry.
', ], ], 'TrainingSpecification' => [ 'base' => 'Defines how the algorithm is used for a training job.
', 'refs' => [ 'CreateAlgorithmInput$TrainingSpecification' => '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.
Details about training jobs run by this algorithm.
', ], ], 'TrainingTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingTimeInSeconds' => 'The training time in seconds.
', 'TrainingJob$TrainingTimeInSeconds' => 'The training time in seconds.
', ], ], 'TransformDataSource' => [ 'base' => 'Describes the location of the channel data.
', 'refs' => [ 'TransformInput$DataSource' => 'Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
', ], ], 'TransformEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$key' => NULL, ], ], 'TransformEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$Environment' => 'The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
', 'DescribeTransformJobResponse$Environment' => 'The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
', 'TransformJob$Environment' => 'The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
', 'TransformJobDefinition$Environment' => 'The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
', ], ], 'TransformEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$value' => NULL, ], ], 'TransformInput' => [ 'base' => 'Describes the input source of a transform job and the way the transform job consumes it.
', 'refs' => [ 'CreateTransformJobRequest$TransformInput' => 'Describes the input source and the way the transform job consumes it.
', 'DescribeTransformJobResponse$TransformInput' => 'Describes the dataset to be transformed and the Amazon S3 location where it is stored.
', 'TransformJob$TransformInput' => NULL, 'TransformJobDefinition$TransformInput' => 'A description of the input source and the way the transform job consumes it.
', ], ], 'TransformInstanceCount' => [ 'base' => NULL, 'refs' => [ 'TransformResources$InstanceCount' => '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 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.
A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
', 'InferenceSpecification$SupportedTransformInstanceTypes' => '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.
', ], ], 'TransformJob' => [ 'base' => 'A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.
', 'refs' => [ 'ModelDashboardModel$LastBatchTransformJob' => NULL, 'TrialComponentSourceDetail$TransformJob' => 'Information about a transform job that\'s the source of a trial component.
', ], ], 'TransformJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobResponse$TransformJobArn' => 'The Amazon Resource Name (ARN) of the transform job.
', 'DescribeTransformJobResponse$TransformJobArn' => 'The Amazon Resource Name (ARN) of the transform job.
', 'TransformJob$TransformJobArn' => 'The Amazon Resource Name (ARN) of the transform job.
', 'TransformJobStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
', 'TransformJobSummary$TransformJobArn' => 'The Amazon Resource Name (ARN) of the transform job.
', ], ], 'TransformJobDefinition' => [ 'base' => 'Defines the input needed to run a transform job using the inference specification specified in the algorithm.
', 'refs' => [ 'AlgorithmValidationProfile$TransformJobDefinition' => 'The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.
The TransformJobDefinition object that describes the transform job used for the validation of the model package.
The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
', 'DescribeTransformJobRequest$TransformJobName' => 'The name of the transform job that you want to view details of.
', 'DescribeTransformJobResponse$TransformJobName' => 'The name of the transform job.
', 'StopTransformJobRequest$TransformJobName' => 'The name of the batch transform job to stop.
', 'TransformJob$TransformJobName' => 'The name of the transform job.
', 'TransformJobSummary$TransformJobName' => 'The name of the transform job.
', ], ], 'TransformJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTransformJobResponse$TransformJobStatus' => 'The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.
A filter that retrieves only transform jobs with a specific status.
', 'TransformJob$TransformJobStatus' => '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 status of the transform job.
', ], ], 'TransformJobStepMetadata' => [ 'base' => 'Metadata for a transform job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$TransformJob' => 'The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
', ], ], 'TransformJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTransformJobsResponse$TransformJobSummaries' => 'An array of TransformJobSummary objects.
Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.
Describes the results of a transform job.
', 'refs' => [ 'CreateTransformJobRequest$TransformOutput' => 'Describes the results of the transform job.
', 'DescribeTransformJobResponse$TransformOutput' => 'Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
', 'TransformJob$TransformOutput' => NULL, 'TransformJobDefinition$TransformOutput' => 'Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
', ], ], 'TransformResources' => [ 'base' => 'Describes the resources, including ML instance types and ML instance count, to use for transform job.
', 'refs' => [ 'CreateTransformJobRequest$TransformResources' => 'Describes the resources, including ML instance types and ML instance count, to use for the transform job.
', 'DescribeTransformJobResponse$TransformResources' => 'Describes the resources, including ML instance types and ML instance count, to use for the transform job.
', 'TransformJob$TransformResources' => NULL, 'TransformJobDefinition$TransformResources' => 'Identifies the ML compute instances for the transform job.
', ], ], 'TransformS3DataSource' => [ 'base' => 'Describes the S3 data source.
', 'refs' => [ 'TransformDataSource$S3DataSource' => 'The S3 location of the data source that is associated with a channel.
', ], ], 'TransformationAttributeName' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$key' => NULL, 'FillingTransformations$key' => NULL, ], ], 'Trial' => [ 'base' => 'The properties of a trial as returned by the Search API.
', 'refs' => [ 'SearchRecord$Trial' => 'The properties of a trial.
', ], ], 'TrialArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'CreateTrialResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'DeleteTrialResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial that is being deleted.
', 'DescribeTrialResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'DisassociateTrialComponentResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'Trial$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'TrialSummary$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'UpdateTrialResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', ], ], 'TrialComponent' => [ 'base' => 'The properties of a trial component as returned by the Search API.
', 'refs' => [ 'SearchRecord$TrialComponent' => 'The properties of a trial component.
', ], ], 'TrialComponentArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'CreateTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'DeleteTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the component is being deleted.
', 'DescribeTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'DisassociateTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'TrialComponent$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'TrialComponentSimpleSummary$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'TrialComponentSummary$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'UpdateTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', ], ], 'TrialComponentArtifact' => [ 'base' => '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.
', 'refs' => [ 'TrialComponentArtifacts$value' => NULL, ], ], 'TrialComponentArtifactValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$Value' => 'The location of the artifact.
', ], ], 'TrialComponentArtifacts' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$InputArtifacts' => 'The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
', 'CreateTrialComponentRequest$OutputArtifacts' => 'The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
', 'DescribeTrialComponentResponse$InputArtifacts' => 'The input artifacts of the component.
', 'DescribeTrialComponentResponse$OutputArtifacts' => 'The output artifacts of the component.
', 'TrialComponent$InputArtifacts' => 'The input artifacts of the component.
', 'TrialComponent$OutputArtifacts' => 'The output artifacts of the component.
', 'UpdateTrialComponentRequest$InputArtifacts' => 'Replaces all of the component\'s input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
', 'UpdateTrialComponentRequest$OutputArtifacts' => 'Replaces all of the component\'s output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
', ], ], 'TrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentKey256$member' => NULL, 'TrialComponentParameters$key' => NULL, ], ], 'TrialComponentKey64' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifacts$key' => NULL, ], ], 'TrialComponentMetricSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Metrics' => 'The metrics for the component.
', 'TrialComponent$Metrics' => 'The metrics for the component.
', ], ], 'TrialComponentMetricSummary' => [ 'base' => 'A summary of the metrics of a trial component.
', 'refs' => [ 'TrialComponentMetricSummaries$member' => NULL, ], ], 'TrialComponentParameterValue' => [ 'base' => 'The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.
This object is specified in the CreateTrialComponent request.
', 'refs' => [ 'TrialComponentParameters$value' => NULL, ], ], 'TrialComponentParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$Parameters' => 'The hyperparameters for the component.
', 'DescribeTrialComponentResponse$Parameters' => 'The hyperparameters of the component.
', 'TrialComponent$Parameters' => 'The hyperparameters of the component.
', 'UpdateTrialComponentRequest$Parameters' => 'Replaces all of the component\'s hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
', ], ], 'TrialComponentPrimaryStatus' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$PrimaryStatus' => 'The status of the trial component.
', ], ], 'TrialComponentSimpleSummaries' => [ 'base' => NULL, 'refs' => [ 'Trial$TrialComponentSummaries' => 'A list of the components associated with the trial. For each component, a summary of the component\'s properties is included.
', ], ], 'TrialComponentSimpleSummary' => [ 'base' => 'A short summary of a trial component.
', 'refs' => [ 'TrialComponentSimpleSummaries$member' => NULL, ], ], 'TrialComponentSource' => [ 'base' => 'The Amazon Resource Name (ARN) and job type of the source of a trial component.
', 'refs' => [ 'DescribeTrialComponentResponse$Source' => 'The Amazon Resource Name (ARN) of the source and, optionally, the job type.
', 'TrialComponent$Source' => 'The Amazon Resource Name (ARN) and job type of the source of the component.
', 'TrialComponentSimpleSummary$TrialComponentSource' => NULL, 'TrialComponentSources$member' => NULL, 'TrialComponentSummary$TrialComponentSource' => NULL, ], ], 'TrialComponentSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$SourceArn' => 'The Amazon Resource Name (ARN) of the source.
', 'TrialComponentSource$SourceArn' => 'The source Amazon Resource Name (ARN).
', 'TrialComponentSourceDetail$SourceArn' => 'The Amazon Resource Name (ARN) of the source.
', ], ], 'TrialComponentSourceDetail' => [ 'base' => 'Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.
Details of the source of the component.
', ], ], 'TrialComponentSources' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Sources' => 'A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
', ], ], 'TrialComponentStatus' => [ 'base' => 'The status of the trial component.
', 'refs' => [ 'CreateTrialComponentRequest$Status' => 'The status of the component. States include:
InProgress
Completed
Failed
The status of the component. States include:
InProgress
Completed
Failed
The status of the component. States include:
InProgress
Completed
Failed
The new status of the component.
', ], ], 'TrialComponentStatusMessage' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$Message' => 'If the component failed, a message describing why.
', ], ], 'TrialComponentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsResponse$TrialComponentSummaries' => 'A list of the summaries of your trial components.
', ], ], 'TrialComponentSummary' => [ 'base' => 'A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.
The source of the trial.
', 'refs' => [ 'DescribeTrialResponse$Source' => 'The Amazon Resource Name (ARN) of the source and, optionally, the job type.
', 'Trial$Source' => NULL, 'TrialSummary$TrialSource' => NULL, ], ], 'TrialSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialSource$SourceArn' => 'The Amazon Resource Name (ARN) of the source.
', ], ], 'TrialSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialsResponse$TrialSummaries' => 'A list of the summaries of your trials.
', ], ], 'TrialSummary' => [ 'base' => 'A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.
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.
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.
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.
TtlDuration time unit.
TtlDuration time value.
The job completion criteria.
', 'refs' => [ 'HyperParameterTuningJobConfig$TuningJobCompletionCriteria' => 'The tuning job\'s completion criteria.
', ], ], 'TuningJobStepMetaData' => [ 'base' => 'Metadata for a tuning step.
', 'refs' => [ 'PipelineExecutionStepMetadata$TuningJob' => 'The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
', ], ], 'USD' => [ 'base' => 'Represents an amount of money in United States dollars.
', 'refs' => [ 'PublicWorkforceTaskPrice$AmountInUsd' => 'Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.
', ], ], 'UiConfig' => [ 'base' => '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.
Information about the user interface that workers use to complete the labeling task.
', ], ], 'UiTemplate' => [ 'base' => 'The Liquid template for the worker user interface.
', 'refs' => [ 'CreateHumanTaskUiRequest$UiTemplate' => NULL, 'RenderUiTemplateRequest$UiTemplate' => 'A Template object containing the worker UI template to render.
Container for user interface template information.
', 'refs' => [ 'DescribeHumanTaskUiResponse$UiTemplate' => NULL, ], ], 'UpdateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$ModelDataUrl' => 'The location of the model artifacts. For more information, see ContainerDefinition.
', 'ClarifyShapBaselineConfig$ShapBaselineUri' => '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 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.
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).
The model artifacts must be in an S3 bucket that is in the same region as the model package.
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).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
', 'refs' => [ 'AssociationSummary$CreatedBy' => NULL, 'DescribeActionResponse$CreatedBy' => NULL, 'DescribeActionResponse$LastModifiedBy' => NULL, 'DescribeArtifactResponse$CreatedBy' => NULL, 'DescribeArtifactResponse$LastModifiedBy' => NULL, 'DescribeContextResponse$CreatedBy' => NULL, 'DescribeContextResponse$LastModifiedBy' => NULL, 'DescribeExperimentResponse$CreatedBy' => 'Who created the experiment.
', 'DescribeExperimentResponse$LastModifiedBy' => 'Who last modified the experiment.
', 'DescribeLineageGroupResponse$CreatedBy' => NULL, 'DescribeLineageGroupResponse$LastModifiedBy' => NULL, 'DescribeModelCardResponse$CreatedBy' => NULL, 'DescribeModelCardResponse$LastModifiedBy' => NULL, 'DescribeModelPackageGroupOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$LastModifiedBy' => NULL, 'DescribePipelineExecutionResponse$CreatedBy' => NULL, 'DescribePipelineExecutionResponse$LastModifiedBy' => NULL, 'DescribePipelineResponse$CreatedBy' => NULL, 'DescribePipelineResponse$LastModifiedBy' => NULL, 'DescribeProjectOutput$CreatedBy' => NULL, 'DescribeProjectOutput$LastModifiedBy' => NULL, 'DescribeTrialComponentResponse$CreatedBy' => 'Who created the trial component.
', 'DescribeTrialComponentResponse$LastModifiedBy' => 'Who last modified the component.
', 'DescribeTrialResponse$CreatedBy' => 'Who created the trial.
', 'DescribeTrialResponse$LastModifiedBy' => 'Who last modified the trial.
', 'Experiment$CreatedBy' => 'Who created the experiment.
', 'Experiment$LastModifiedBy' => NULL, 'ModelCard$CreatedBy' => NULL, 'ModelCard$LastModifiedBy' => NULL, 'ModelDashboardModelCard$CreatedBy' => NULL, 'ModelDashboardModelCard$LastModifiedBy' => NULL, 'ModelPackage$CreatedBy' => 'Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
', 'ModelPackage$LastModifiedBy' => 'Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
', 'ModelPackageGroup$CreatedBy' => NULL, 'Pipeline$CreatedBy' => NULL, 'Pipeline$LastModifiedBy' => NULL, 'PipelineExecution$CreatedBy' => NULL, 'PipelineExecution$LastModifiedBy' => NULL, 'Project$CreatedBy' => 'Who created the project.
', 'Project$LastModifiedBy' => NULL, 'Trial$CreatedBy' => 'Who created the trial.
', 'Trial$LastModifiedBy' => NULL, 'TrialComponent$CreatedBy' => 'Who created the trial component.
', 'TrialComponent$LastModifiedBy' => NULL, 'TrialComponentSimpleSummary$CreatedBy' => NULL, 'TrialComponentSummary$CreatedBy' => 'Who created the trial component.
', 'TrialComponentSummary$LastModifiedBy' => 'Who last modified the component.
', ], ], 'UserProfileArn' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileResponse$UserProfileArn' => 'The user profile Amazon Resource Name (ARN).
', 'DescribeUserProfileResponse$UserProfileArn' => 'The user profile Amazon Resource Name (ARN).
', 'UpdateUserProfileResponse$UserProfileArn' => 'The user profile Amazon Resource Name (ARN).
', ], ], 'UserProfileDetails' => [ 'base' => 'The user profile details.
', 'refs' => [ 'UserProfileList$member' => NULL, ], ], 'UserProfileList' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesResponse$UserProfiles' => 'The list of user profiles.
', ], ], 'UserProfileName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$UserProfileName' => 'The user profile name.
', 'CreateAppRequest$UserProfileName' => 'The user profile name. If this value is not set, then SpaceName must be set.
The name of the UserProfile to sign-in as.
', 'CreateUserProfileRequest$UserProfileName' => 'A name for the UserProfile. This value is not case sensitive.
', 'DeleteAppRequest$UserProfileName' => 'The user profile name. If this value is not set, then SpaceName must be set.
The user profile name.
', 'DescribeAppRequest$UserProfileName' => 'The user profile name. If this value is not set, then SpaceName must be set.
The user profile name.
', 'DescribeUserProfileRequest$UserProfileName' => 'The user profile name. This value is not case sensitive.
', 'DescribeUserProfileResponse$UserProfileName' => 'The user profile name.
', 'ListAppsRequest$UserProfileNameEquals' => 'A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.
A parameter by which to filter the results.
', 'UpdateUserProfileRequest$UserProfileName' => 'The user profile name.
', 'UserProfileDetails$UserProfileName' => 'The user profile name.
', ], ], 'UserProfileSortKey' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesRequest$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
', ], ], 'UserProfileStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeUserProfileResponse$Status' => 'The status.
', 'UserProfileDetails$Status' => 'The status.
', ], ], 'UserSettings' => [ 'base' => 'A collection of settings that apply to users of Amazon SageMaker Studio. 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 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.
A collection of settings.
', 'DescribeDomainResponse$DefaultUserSettings' => 'Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
', 'DescribeUserProfileResponse$UserSettings' => 'A collection of settings.
', 'UpdateDomainRequest$DefaultUserSettings' => 'A collection of settings.
', 'UpdateUserProfileRequest$UserSettings' => 'A collection of settings.
', ], ], 'UsersPerStep' => [ 'base' => NULL, 'refs' => [ 'Stairs$UsersPerStep' => 'Specifies how many new users to spawn in each step.
', ], ], 'UtilizationMetric' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$CpuUtilization' => '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.
NaN indicates that the value is not available.
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.
', ], ], 'VariantName' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$VariantName' => 'The name of the variant to update.
', 'PendingProductionVariantSummary$VariantName' => 'The name of the variant.
', 'ProductionVariant$VariantName' => 'The name of the production variant.
', 'ProductionVariantSummary$VariantName' => 'The name of the variant.
', ], ], 'VariantProperty' => [ 'base' => '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.
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 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.)
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.
A message that describes the status of the production variant.
', ], ], 'VariantWeight' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredWeight' => 'The variant\'s weight.
', 'PendingProductionVariantSummary$CurrentWeight' => 'The weight associated with the variant.
', 'PendingProductionVariantSummary$DesiredWeight' => '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.
', 'ProductionVariant$InitialVariantWeight' => '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.
The weight associated with the variant.
', 'ProductionVariantSummary$DesiredWeight' => 'The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
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.
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.
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.
Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
', ], ], 'VersionedArnOrName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ModelPackageName' => 'The name or Amazon Resource Name (ARN) of the model package to use to create the model.
', 'DeleteModelPackageInput$ModelPackageName' => '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).
', 'DescribeModelPackageInput$ModelPackageName' => '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).
', ], ], 'Vertex' => [ 'base' => 'A lineage entity connected to the starting entity(ies).
', 'refs' => [ 'Vertices$member' => NULL, ], ], 'Vertices' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Vertices' => 'A list of vertices connected to the start entity(ies) in the lineage graph.
', ], ], 'VolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$VolumeSizeInGB' => 'The volume size in GB of the data to be processed for hyperparameter optimization (optional).
', 'ResourceConfig$VolumeSizeInGB' => '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.
', ], ], 'VpcConfig' => [ 'base' => 'Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.
', 'refs' => [ 'AutoMLSecurityConfig$VpcConfig' => 'The VPC configuration.
', 'CreateModelInput$VpcConfig' => '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.
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.
', 'DescribeModelOutput$VpcConfig' => '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
', 'DescribeTrainingJobResponse$VpcConfig' => '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.
', 'HyperParameterTrainingJobDefinition$VpcConfig' => '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.
', 'LabelingJobResourceConfig$VpcConfig' => NULL, 'Model$VpcConfig' => NULL, 'MonitoringNetworkConfig$VpcConfig' => NULL, 'NetworkConfig$VpcConfig' => NULL, 'TrainingJob$VpcConfig' => '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.
', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$VpcId' => 'The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
', 'DescribeDomainResponse$VpcId' => 'The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
', ], ], 'VpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SecurityGroupIds' => '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 length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.
', 'TrafficRoutingConfig$WaitIntervalInSeconds' => 'The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
', ], ], 'WarmPoolResourceStatus' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsRequest$WarmPoolStatusEquals' => 'A filter that retrieves only training jobs with a specific warm pool status.
', 'WarmPoolStatus$Status' => '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.
Status and billing information about the warm pool.
', 'refs' => [ 'DescribeTrainingJobResponse$WarmPoolStatus' => 'The status of the warm pool associated with the training job.
', 'TrainingJobSummary$WarmPoolStatus' => 'The status of the warm pool associated with the training job.
', ], ], 'Workforce' => [ 'base' => '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.
', 'refs' => [ 'DescribeWorkforceResponse$Workforce' => '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.
', 'UpdateWorkforceResponse$Workforce' => '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.
', 'Workforces$member' => NULL, ], ], 'WorkforceArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceResponse$WorkforceArn' => 'The Amazon Resource Name (ARN) of the workforce.
', 'Workforce$WorkforceArn' => 'The Amazon Resource Name (ARN) of the private workforce.
', 'Workteam$WorkforceArn' => 'The Amazon Resource Name (ARN) of the workforce.
', ], ], 'WorkforceFailureReason' => [ 'base' => NULL, 'refs' => [ 'Workforce$FailureReason' => 'The reason your workforce failed.
', ], ], 'WorkforceName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceRequest$WorkforceName' => 'The name of the private workforce.
', 'CreateWorkteamRequest$WorkforceName' => 'The name of the workforce.
', 'DeleteWorkforceRequest$WorkforceName' => 'The name of the workforce.
', 'DescribeWorkforceRequest$WorkforceName' => '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 filter you can use to search for workforces using part of the workforce name.
', 'UpdateWorkforceRequest$WorkforceName' => 'The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.
', 'Workforce$WorkforceName' => 'The name of the private workforce.
', ], ], 'WorkforceSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSecurityGroupIds$member' => NULL, ], ], 'WorkforceSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$SecurityGroupIds' => 'The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
', 'WorkforceVpcConfigResponse$SecurityGroupIds' => 'The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
', ], ], 'WorkforceStatus' => [ 'base' => NULL, 'refs' => [ 'Workforce$Status' => 'The status of your workforce.
', ], ], 'WorkforceSubnetId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSubnets$member' => NULL, ], ], 'WorkforceSubnets' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$Subnets' => 'The ID of the subnets in the VPC that you want to connect.
', 'WorkforceVpcConfigResponse$Subnets' => 'The ID of the subnets in the VPC that you want to connect.
', ], ], 'WorkforceVpcConfigRequest' => [ 'base' => 'The VPC object you use to create or update a workforce.
', 'refs' => [ 'CreateWorkforceRequest$WorkforceVpcConfig' => 'Use this parameter to configure a workforce using VPC.
', 'UpdateWorkforceRequest$WorkforceVpcConfig' => 'Use this parameter to update your VPC configuration for a workforce.
', ], ], 'WorkforceVpcConfigResponse' => [ 'base' => 'A VpcConfig object that specifies the VPC that you want your workforce to connect to.
', 'refs' => [ 'Workforce$WorkforceVpcConfig' => 'The configuration of a VPC workforce.
', ], ], 'WorkforceVpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigResponse$VpcEndpointId' => 'The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.
', ], ], 'WorkforceVpcId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$VpcId' => 'The ID of the VPC that the workforce uses for communication.
', 'WorkforceVpcConfigResponse$VpcId' => 'The ID of the VPC that the workforce uses for communication.
', ], ], 'Workforces' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesResponse$Workforces' => 'A list containing information about your workforce.
', ], ], 'WorkspaceSettings' => [ 'base' => 'The workspace settings for the SageMaker Canvas application.
', 'refs' => [ 'CanvasAppSettings$WorkspaceSettings' => 'The workspace settings for the SageMaker Canvas application.
', ], ], 'Workteam' => [ 'base' => 'Provides details about a labeling work team.
', 'refs' => [ 'DescribeWorkteamResponse$Workteam' => 'A Workteam instance that contains information about the work team.
A Workteam object that describes the updated work team.
The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.
', 'DescribeSubscribedWorkteamRequest$WorkteamArn' => 'The Amazon Resource Name (ARN) of the subscribed work team to describe.
', 'HumanLoopConfig$WorkteamArn' => '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.
', 'HumanTaskConfig$WorkteamArn' => 'The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.
', 'LabelingJobSummary$WorkteamArn' => 'The Amazon Resource Name (ARN) of the work team assigned to the job.
', 'ListLabelingJobsForWorkteamRequest$WorkteamArn' => 'The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
', 'SubscribedWorkteam$WorkteamArn' => 'The Amazon Resource Name (ARN) of the vendor that you have subscribed.
', 'Workteam$WorkteamArn' => 'The Amazon Resource Name (ARN) that identifies the work team.
', ], ], 'WorkteamName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$WorkteamName' => 'The name of the work team. Use this name to identify the work team.
', 'DeleteWorkteamRequest$WorkteamName' => 'The name of the work team to delete.
', 'DescribeWorkteamRequest$WorkteamName' => 'The name of the work team to return a description of.
', 'ListSubscribedWorkteamsRequest$NameContains' => 'A string in the work team name. This filter returns only work teams whose name contains the specified string.
', 'ListWorkteamsRequest$NameContains' => 'A string in the work team\'s name. This filter returns only work teams whose name contains the specified string.
', 'UpdateWorkteamRequest$WorkteamName' => 'The name of the work team to update.
', 'Workteam$WorkteamName' => 'The name of the work team.
', ], ], 'Workteams' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsResponse$Workteams' => 'An array of Workteam objects, each describing a work team.
Provides APIs for creating and managing SageMaker resources.
Other Resources:
', 'operations' => [ 'AddAssociation' => '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.
', 'AddTags' => '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 Studio 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.
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.
', 'BatchDescribeModelPackage' => 'This action batch describes a list of versioned model packages
', 'CreateAction' => '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.
', 'CreateAlgorithm' => 'Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
', 'CreateApp' => 'Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
', 'CreateAppImageConfig' => 'Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.
', 'CreateArtifact' => '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.
', 'CreateAutoMLJob' => 'Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
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 non-tabular problem types such as image or text classification.
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.
', 'CreateAutoMLJobV2' => 'Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
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 non-tabular problem types such as image or text classification.
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.
', 'CreateCodeRepository' => 'Creates a Git repository as a resource in your SageMaker 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 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.
', 'CreateCompilationJob' => 'Starts a model compilation job. After the model has been compiled, Amazon SageMaker 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 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 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.
', 'CreateContext' => '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.
', 'CreateDataQualityJobDefinition' => 'Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
', 'CreateDeviceFleet' => 'Creates a device fleet.
', 'CreateDomain' => 'Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) 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 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 SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly - All Studio 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 Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker 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 SageMaker Studio app successfully.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
', 'CreateEdgeDeploymentPlan' => 'Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
', 'CreateEdgeDeploymentStage' => 'Creates a new stage in an existing edge deployment plan.
', 'CreateEdgePackagingJob' => 'Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
', 'CreateEndpoint' => 'Creates 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.
For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook.
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 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.
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.
', 'CreateFeatureGroup' => '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.
You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.
Creates a flow definition.
', 'CreateHub' => 'Create a hub.
Hub APIs are only callable through SageMaker Studio.
Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
', 'CreateHyperParameterTuningJob' => 'Starts 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 field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image.
', 'CreateImageVersion' => 'Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.
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.
', 'CreateInferenceRecommendationsJob' => 'Starts a recommendation job. You can create either an instance recommendation or load test job.
', 'CreateLabelingJob' => '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.
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.
For an example that calls this method when deploying a model to SageMaker hosting services, see Create a Model (Amazon Web Services SDK for Python (Boto 3)).
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.
', 'CreateModelBiasJobDefinition' => 'Creates the definition for a model bias job.
', 'CreateModelCard' => 'Creates an Amazon SageMaker Model Card.
For information about how to use model cards, see Amazon SageMaker Model Card.
', 'CreateModelCardExportJob' => 'Creates an Amazon SageMaker Model Card export job.
', 'CreateModelExplainabilityJobDefinition' => 'Creates the definition for a model explainability job.
', 'CreateModelPackage' => '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 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.
Creates a model group. A model group contains a group of model versions.
', 'CreateModelQualityJobDefinition' => 'Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
', 'CreateMonitoringSchedule' => 'Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.
', 'CreateNotebookInstance' => 'Creates an SageMaker 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 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 also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.
After receiving the request, SageMaker does the following:
Creates a network interface in the SageMaker VPC.
(Option) If you specified SubnetId, SageMaker 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 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 VPC. If you specified SubnetId of your VPC, SageMaker 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 returns its Amazon Resource Name (ARN). You can\'t change the name of a notebook instance after you create it.
After SageMaker 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 endpoints, and validate hosted models.
For more information, see How It Works.
', 'CreateNotebookInstanceLifecycleConfig' => '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 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.
', 'CreatePipeline' => 'Creates a pipeline using a JSON pipeline definition.
', 'CreatePresignedDomainUrl' => 'Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of the Apps and files associated with the Domain\'s Amazon Elastic File System (EFS) 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 SageMaker 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.
Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker 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.
Creates a processing job.
', 'CreateProject' => '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.
', 'CreateSpace' => 'Creates a space used for real time collaboration in a Domain.
', 'CreateStudioLifecycleConfig' => 'Creates a new Studio Lifecycle Configuration.
', 'CreateTrainingJob' => '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 field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
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.
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.
', 'CreateTransformJob' => '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 for the transform job.
For more information about how batch transformation works, see Batch Transform.
', 'CreateTrial' => '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.
', 'CreateTrialComponent' => '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.
', 'CreateUserProfile' => '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 Amazon SageMaker Studio. 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 (EFS) home directory.
', 'CreateWorkforce' => '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).
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.
', 'DeleteAction' => 'Deletes an action.
', 'DeleteAlgorithm' => 'Removes the specified algorithm from your account.
', 'DeleteApp' => 'Used to stop and delete an app.
', 'DeleteAppImageConfig' => 'Deletes an AppImageConfig.
', 'DeleteArtifact' => 'Deletes an artifact. Either ArtifactArn or Source must be specified.
Deletes an association.
', 'DeleteCodeRepository' => 'Deletes the specified Git repository from your account.
', 'DeleteContext' => 'Deletes an context.
', 'DeleteDataQualityJobDefinition' => 'Deletes a data quality monitoring job definition.
', 'DeleteDeviceFleet' => 'Deletes a fleet.
', 'DeleteDomain' => '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.
', 'DeleteEdgeDeploymentPlan' => '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.
', 'DeleteEdgeDeploymentStage' => 'Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
', 'DeleteEndpoint' => '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 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 first. Use the ListTrials API to get a list of the trials associated with the experiment.
', 'DeleteFeatureGroup' => '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.
Deletes the specified flow definition.
', 'DeleteHub' => 'Delete a hub.
Hub APIs are only callable through SageMaker Studio.
Delete the contents of a hub.
Hub APIs are only callable through SageMaker Studio.
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 SageMaker image and all versions of the image. The container images aren\'t deleted.
', 'DeleteImageVersion' => 'Deletes a version of a SageMaker image. The container image the version represents isn\'t deleted.
', 'DeleteInferenceExperiment' => 'Deletes an inference experiment.
This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.
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 an Amazon SageMaker model bias job definition.
', 'DeleteModelCard' => 'Deletes an Amazon SageMaker Model Card.
', 'DeleteModelExplainabilityJobDefinition' => 'Deletes an Amazon SageMaker model explainability job definition.
', 'DeleteModelPackage' => '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.
', 'DeleteModelPackageGroup' => 'Deletes the specified model group.
', 'DeleteModelPackageGroupPolicy' => 'Deletes a model group resource policy.
', 'DeleteModelQualityJobDefinition' => 'Deletes the secified model quality monitoring job definition.
', 'DeleteMonitoringSchedule' => '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.
', 'DeleteNotebookInstance' => ' Deletes an SageMaker 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 removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
Deletes a notebook instance lifecycle configuration.
', 'DeletePipeline' => '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.
Delete the specified project.
', 'DeleteSpace' => 'Used to delete a space.
', 'DeleteStudioLifecycleConfig' => 'Deletes the 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.
', 'DeleteTags' => 'Deletes 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 Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API.
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.
', 'DeleteTrialComponent' => '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.
', 'DeleteUserProfile' => 'Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.
', 'DeleteWorkforce' => '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 recieve a ResourceInUse error.
Deletes an existing work team. This operation can\'t be undone.
', 'DeregisterDevices' => 'Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
', 'DescribeAction' => 'Describes an action.
', 'DescribeAlgorithm' => 'Returns a description of the specified algorithm that is in your account.
', 'DescribeApp' => 'Describes the app.
', 'DescribeAppImageConfig' => 'Describes an AppImageConfig.
', 'DescribeArtifact' => 'Describes an artifact.
', 'DescribeAutoMLJob' => 'Returns information about an AutoML job created by calling CreateAutoMLJob.
AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.
Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.
', 'DescribeCodeRepository' => 'Gets details about the specified Git repository.
', 'DescribeCompilationJob' => '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.
', 'DescribeContext' => 'Describes a context.
', 'DescribeDataQualityJobDefinition' => 'Gets the details of a data quality monitoring job definition.
', 'DescribeDevice' => 'Describes the device.
', 'DescribeDeviceFleet' => 'A description of the fleet the device belongs to.
', 'DescribeDomain' => 'The description of the domain.
', 'DescribeEdgeDeploymentPlan' => 'Describes an edge deployment plan with deployment status per stage.
', 'DescribeEdgePackagingJob' => 'A description of edge packaging jobs.
', 'DescribeEndpoint' => 'Returns the description of an endpoint.
', 'DescribeEndpointConfig' => 'Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Provides a list of an experiment\'s properties.
', 'DescribeFeatureGroup' => '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.
Shows the metadata for a feature within a feature group.
', 'DescribeFlowDefinition' => 'Returns information about the specified flow definition.
', 'DescribeHub' => 'Describe a hub.
Hub APIs are only callable through SageMaker Studio.
Describe the content of a hub.
Hub APIs are only callable through SageMaker Studio.
Returns information about the requested human task user interface (worker task template).
', 'DescribeHyperParameterTuningJob' => '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.
', 'DescribeImage' => 'Describes a SageMaker image.
', 'DescribeImageVersion' => 'Describes a version of a SageMaker image.
', 'DescribeInferenceExperiment' => 'Returns details about an inference experiment.
', 'DescribeInferenceRecommendationsJob' => 'Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.
', 'DescribeLabelingJob' => 'Gets information about a labeling job.
', 'DescribeLineageGroup' => 'Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
', 'DescribeModel' => 'Describes a model that you created using the CreateModel API.
Returns a description of a model bias job definition.
', 'DescribeModelCard' => 'Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
', 'DescribeModelCardExportJob' => 'Describes an Amazon SageMaker Model Card export job.
', 'DescribeModelExplainabilityJobDefinition' => 'Returns a description of a model explainability job definition.
', 'DescribeModelPackage' => 'Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
', 'DescribeModelPackageGroup' => 'Gets a description for the specified model group.
', 'DescribeModelQualityJobDefinition' => 'Returns a description of a model quality job definition.
', 'DescribeMonitoringSchedule' => 'Describes the schedule for a monitoring job.
', 'DescribeNotebookInstance' => 'Returns information about a notebook instance.
', 'DescribeNotebookInstanceLifecycleConfig' => '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.
', 'DescribePipeline' => 'Describes the details of a pipeline.
', 'DescribePipelineDefinitionForExecution' => 'Describes the details of an execution\'s pipeline definition.
', 'DescribePipelineExecution' => 'Describes the details of a pipeline execution.
', 'DescribeProcessingJob' => 'Returns a description of a processing job.
', 'DescribeProject' => 'Describes the details of a project.
', 'DescribeSpace' => 'Describes the space.
', 'DescribeStudioLifecycleConfig' => 'Describes the Studio Lifecycle Configuration.
', 'DescribeSubscribedWorkteam' => '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.
', 'DescribeTrainingJob' => '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.
Returns information about a transform job.
', 'DescribeTrial' => 'Provides a list of a trial\'s properties.
', 'DescribeTrialComponent' => 'Provides a list of a trials component\'s properties.
', 'DescribeUserProfile' => 'Describes a user profile. For more information, see CreateUserProfile.
Lists 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.
Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team\'s Amazon Resource Name (ARN).
', 'DisableSagemakerServicecatalogPortfolio' => 'Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
', 'DisassociateTrialComponent' => '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.
Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
', 'GetDeviceFleetReport' => 'Describes a fleet.
', 'GetLineageGroupPolicy' => 'The resource policy for the lineage group.
', 'GetModelPackageGroupPolicy' => '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..
', 'GetSagemakerServicecatalogPortfolioStatus' => 'Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
', 'GetScalingConfigurationRecommendation' => 'Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.
', 'GetSearchSuggestions' => '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.
Import hub content.
Hub APIs are only callable through SageMaker Studio.
Lists the actions in your account and their properties.
', 'ListAlgorithms' => 'Lists the machine learning algorithms that have been created.
', 'ListAliases' => 'Lists the aliases of a specified image or image version.
', 'ListAppImageConfigs' => '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.
', 'ListApps' => 'Lists apps.
', 'ListArtifacts' => 'Lists the artifacts in your account and their properties.
', 'ListAssociations' => 'Lists the associations in your account and their properties.
', 'ListAutoMLJobs' => 'Request a list of jobs.
', 'ListCandidatesForAutoMLJob' => 'List the candidates created for the job.
', 'ListCodeRepositories' => 'Gets a list of the Git repositories in your account.
', 'ListCompilationJobs' => '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.
', 'ListContexts' => 'Lists the contexts in your account and their properties.
', 'ListDataQualityJobDefinitions' => 'Lists the data quality job definitions in your account.
', 'ListDeviceFleets' => 'Returns a list of devices in the fleet.
', 'ListDevices' => 'A list of devices.
', 'ListDomains' => 'Lists the domains.
', 'ListEdgeDeploymentPlans' => 'Lists all edge deployment plans.
', 'ListEdgePackagingJobs' => 'Returns a list of edge packaging jobs.
', 'ListEndpointConfigs' => 'Lists endpoint configurations.
', 'ListEndpoints' => 'Lists endpoints.
', 'ListExperiments' => '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.
', 'ListFeatureGroups' => 'List FeatureGroups based on given filter and order.
Returns information about the flow definitions in your account.
', 'ListHubContentVersions' => 'List hub content versions.
Hub APIs are only callable through SageMaker Studio.
List the contents of a hub.
Hub APIs are only callable through SageMaker Studio.
List all existing hubs.
Hub APIs are only callable through SageMaker Studio.
Returns information about the human task user interfaces in your account.
', 'ListHyperParameterTuningJobs' => 'Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
', 'ListImageVersions' => 'Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
', 'ListImages' => '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.
', 'ListInferenceExperiments' => 'Returns the list of all inference experiments.
', 'ListInferenceRecommendationsJobSteps' => '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.
', 'ListInferenceRecommendationsJobs' => 'Lists recommendation jobs that satisfy various filters.
', 'ListLabelingJobs' => 'Gets a list of labeling jobs.
', 'ListLabelingJobsForWorkteam' => 'Gets a list of labeling jobs assigned to a specified work team.
', 'ListLineageGroups' => '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.
', 'ListModelBiasJobDefinitions' => 'Lists model bias jobs definitions that satisfy various filters.
', 'ListModelCardExportJobs' => 'List the export jobs for the Amazon SageMaker Model Card.
', 'ListModelCardVersions' => 'List existing versions of an Amazon SageMaker Model Card.
', 'ListModelCards' => 'List existing model cards.
', 'ListModelExplainabilityJobDefinitions' => 'Lists model explainability job definitions that satisfy various filters.
', 'ListModelMetadata' => 'Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.
', 'ListModelPackageGroups' => 'Gets a list of the model groups in your Amazon Web Services account.
', 'ListModelPackages' => 'Lists the model packages that have been created.
', 'ListModelQualityJobDefinitions' => 'Gets a list of model quality monitoring job definitions in your account.
', 'ListModels' => 'Lists models created with the CreateModel API.
Gets a list of past alerts in a model monitoring schedule.
', 'ListMonitoringAlerts' => 'Gets the alerts for a single monitoring schedule.
', 'ListMonitoringExecutions' => 'Returns list of all monitoring job executions.
', 'ListMonitoringSchedules' => 'Returns list of all monitoring schedules.
', 'ListNotebookInstanceLifecycleConfigs' => 'Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
', 'ListNotebookInstances' => 'Returns a list of the SageMaker notebook instances in the requester\'s account in an Amazon Web Services Region.
', 'ListPipelineExecutionSteps' => 'Gets a list of PipeLineExecutionStep objects.
Gets a list of the pipeline executions.
', 'ListPipelineParametersForExecution' => 'Gets a list of parameters for a pipeline execution.
', 'ListPipelines' => 'Gets a list of pipelines.
', 'ListProcessingJobs' => 'Lists processing jobs that satisfy various filters.
', 'ListProjects' => 'Gets a list of the projects in an Amazon Web Services account.
', 'ListResourceCatalogs' => ' Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.
Lists spaces.
', 'ListStageDevices' => 'Lists devices allocated to the stage, containing detailed device information and deployment status.
', 'ListStudioLifecycleConfigs' => 'Lists the Studio Lifecycle Configurations in your Amazon Web Services Account.
', 'ListSubscribedWorkteams' => '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.
Returns the tags for the specified SageMaker resource.
', 'ListTrainingJobs' => '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 hyperparameter tuning job launched.
', 'ListTransformJobs' => 'Lists transform jobs.
', 'ListTrialComponents' => '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
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.
', 'ListUserProfiles' => 'Lists user profiles.
', 'ListWorkforces' => '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.
', 'ListWorkteams' => '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.
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..
', 'QueryLineage' => '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.
', 'RegisterDevices' => 'Register devices.
', 'RenderUiTemplate' => 'Renders the UI template so that you can preview the worker\'s experience.
', 'RetryPipelineExecution' => 'Retry the execution of the pipeline.
', 'Search' => 'Finds 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.
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).
', 'SendPipelineExecutionStepSuccess' => '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).
', 'StartEdgeDeploymentStage' => 'Starts a stage in an edge deployment plan.
', 'StartInferenceExperiment' => 'Starts an inference experiment.
', 'StartMonitoringSchedule' => '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 attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance\'s status must be InService before you can connect to your Jupyter notebook.
Starts a pipeline execution.
', 'StopAutoMLJob' => 'A method for forcing a running job to shut down.
', 'StopCompilationJob' => 'Stops a model compilation job.
To stop a job, Amazon SageMaker 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 changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.
Stops a stage in an edge deployment plan.
', 'StopEdgePackagingJob' => 'Request to stop an edge packaging job.
', 'StopHyperParameterTuningJob' => '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.
Stops an inference experiment.
', 'StopInferenceRecommendationsJob' => 'Stops an Inference Recommender job.
', 'StopLabelingJob' => '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.
', 'StopMonitoringSchedule' => 'Stops a previously started monitoring schedule.
', 'StopNotebookInstance' => 'Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker 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.
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.
Stops a processing job.
', 'StopTrainingJob' => '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.
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.
Updates an action.
', 'UpdateAppImageConfig' => 'Updates the properties of an AppImageConfig.
', 'UpdateArtifact' => 'Updates an artifact.
', 'UpdateCodeRepository' => 'Updates the specified Git repository with the specified values.
', 'UpdateContext' => 'Updates a context.
', 'UpdateDeviceFleet' => 'Updates a fleet of devices.
', 'UpdateDevices' => 'Updates one or more devices in a fleet.
', 'UpdateDomain' => 'Updates the default settings for new user profiles in the domain.
', 'UpdateEndpoint' => 'Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).
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.
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 experiment.
', 'UpdateFeatureGroup' => '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.
Updates the description and parameters of the feature group.
', 'UpdateHub' => 'Update a hub.
Hub APIs are only callable through SageMaker Studio.
Updates the properties of a SageMaker image. To change the image\'s tags, use the AddTags and DeleteTags APIs.
', 'UpdateImageVersion' => 'Updates the properties of a SageMaker image version.
', 'UpdateInferenceExperiment' => ' 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.
Update an Amazon SageMaker Model Card.
You cannot update both model card content and model card status in a single call.
Updates a versioned model.
', 'UpdateMonitoringAlert' => 'Update the parameters of a model monitor alert.
', 'UpdateMonitoringSchedule' => 'Updates a previously created schedule.
', 'UpdateNotebookInstance' => '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.
', 'UpdateNotebookInstanceLifecycleConfig' => 'Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
', 'UpdatePipeline' => 'Updates a pipeline.
', 'UpdatePipelineExecution' => 'Updates a pipeline execution.
', 'UpdateProject' => '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.
Updates the settings of a space.
', 'UpdateTrainingJob' => 'Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.
', 'UpdateTrial' => 'Updates the display name of a trial.
', 'UpdateTrialComponent' => 'Updates one or more properties of a trial component.
', 'UpdateUserProfile' => 'Updates a user profile.
', 'UpdateWorkforce' => 'Use 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.
Updates an existing work team with new member definitions or description.
', ], 'shapes' => [ 'Accept' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$Accept' => '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.
', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'LabelingJobForWorkteamSummary$WorkRequesterAccountId' => 'The Amazon Web Services account ID of the account used to start the labeling job.
', ], ], 'ActionArn' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', 'CreateActionResponse$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', 'DeleteActionResponse$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', 'DescribeActionResponse$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', 'UpdateActionResponse$ActionArn' => 'The Amazon Resource Name (ARN) of the action.
', ], ], 'ActionSource' => [ 'base' => 'A structure describing the source of an action.
', 'refs' => [ 'ActionSummary$Source' => 'The source of the action.
', 'CreateActionRequest$Source' => 'The source type, ID, and URI.
', 'DescribeActionResponse$Source' => 'The source of the action.
', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$Status' => 'The status of the action.
', 'CreateActionRequest$Status' => 'The status of the action.
', 'DescribeActionResponse$Status' => 'The status of the action.
', 'UpdateActionRequest$Status' => 'The new status for the action.
', ], ], 'ActionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListActionsResponse$ActionSummaries' => 'A list of actions and their properties.
', ], ], 'ActionSummary' => [ 'base' => '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.
', 'refs' => [ 'ActionSummaries$member' => NULL, ], ], 'AddAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AdditionalCodeRepositories' => '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 Notebook Instances.
', 'DescribeNotebookInstanceOutput$AdditionalCodeRepositories' => '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 Notebook Instances.
', 'NotebookInstanceSummary$AdditionalCodeRepositories' => '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 Notebook Instances.
', 'UpdateNotebookInstanceInput$AdditionalCodeRepositories' => '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 Notebook Instances.
', ], ], 'AdditionalInferenceSpecificationDefinition' => [ 'base' => '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
', 'refs' => [ 'AdditionalInferenceSpecifications$member' => NULL, ], ], 'AdditionalInferenceSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$AdditionalInferenceSpecifications' => '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.
', 'DescribeModelPackageOutput$AdditionalInferenceSpecifications' => '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.
', 'ModelPackage$AdditionalInferenceSpecifications' => 'An array of additional Inference Specification objects.
', 'UpdateModelPackageInput$AdditionalInferenceSpecificationsToAdd' => '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.
', ], ], 'AgentVersion' => [ 'base' => 'Edge Manager agent version.
', 'refs' => [ 'AgentVersions$member' => NULL, ], ], 'AgentVersions' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$AgentVersions' => 'The versions of Edge Manager agent deployed on the fleet.
', ], ], 'AggregationTransformationValue' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$value' => NULL, ], ], 'AggregationTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Aggregation' => 'A 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.
An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
', 'refs' => [ 'AlarmList$member' => NULL, ], ], 'AlarmList' => [ 'base' => NULL, 'refs' => [ 'AutoRollbackConfig$Alarms' => '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.
', ], ], 'AlarmName' => [ 'base' => NULL, 'refs' => [ 'Alarm$AlarmName' => 'The name of a CloudWatch alarm in your account.
', ], ], 'AlgorithmArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmArn' => 'The Amazon Resource Name (ARN) of the algorithm.
', 'CreateAlgorithmOutput$AlgorithmArn' => 'The Amazon Resource Name (ARN) of the new algorithm.
', 'DescribeAlgorithmOutput$AlgorithmArn' => 'The Amazon Resource Name (ARN) of the algorithm.
', ], ], 'AlgorithmImage' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$TrainingImage' => '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 Amazon Elastic Container (ECR) Image for the managed rule evaluation.
', 'HyperParameterAlgorithmSpecification$TrainingImage' => ' 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 Amazon Elastic Container Registry Image for the managed rule evaluation.
', ], ], 'AlgorithmSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
Specifies the training algorithm to use in a CreateTrainingJob request.
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.
', 'refs' => [ 'CreateTrainingJobRequest$AlgorithmSpecification' => '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.
', 'DescribeTrainingJobResponse$AlgorithmSpecification' => 'Information about the algorithm used for training, and algorithm metadata.
', 'TrainingJob$AlgorithmSpecification' => 'Information about the algorithm used for training, and algorithm metadata.
', ], ], 'AlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmStatus' => 'The overall status of the algorithm.
', 'DescribeAlgorithmOutput$AlgorithmStatus' => 'The current status of the algorithm.
', ], ], 'AlgorithmStatusDetails' => [ 'base' => 'Specifies the validation and image scan statuses of the algorithm.
', 'refs' => [ 'DescribeAlgorithmOutput$AlgorithmStatusDetails' => 'Details about the current status of the algorithm.
', ], ], 'AlgorithmStatusItem' => [ 'base' => 'Represents the overall status of an algorithm.
', 'refs' => [ 'AlgorithmStatusItemList$member' => NULL, ], ], 'AlgorithmStatusItemList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusDetails$ValidationStatuses' => 'The status of algorithm validation.
', 'AlgorithmStatusDetails$ImageScanStatuses' => 'The status of the scan of the algorithm\'s Docker image container.
', ], ], 'AlgorithmSummary' => [ 'base' => 'Provides summary information about an algorithm.
', 'refs' => [ 'AlgorithmSummaryList$member' => NULL, ], ], 'AlgorithmSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsOutput$AlgorithmSummaryList' => '>An array of AlgorithmSummary objects, each of which lists an algorithm.
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.
', 'refs' => [ 'AlgorithmValidationProfiles$member' => NULL, ], ], 'AlgorithmValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationProfiles' => '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 algorithm.
', 'refs' => [ 'CreateAlgorithmInput$ValidationSpecification' => '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.
', 'DescribeAlgorithmOutput$ValidationSpecification' => 'Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.
', ], ], 'AnnotationConsolidationConfig' => [ 'base' => 'Configures how labels are consolidated across human workers and processes output data.
', 'refs' => [ 'HumanTaskConfig$AnnotationConsolidationConfig' => 'Configures how labels are consolidated across human workers.
', ], ], 'AppArn' => [ 'base' => NULL, 'refs' => [ 'CreateAppResponse$AppArn' => 'The Amazon Resource Name (ARN) of the app.
', 'DescribeAppResponse$AppArn' => 'The Amazon Resource Name (ARN) of the app.
', ], ], 'AppDetails' => [ 'base' => 'Details about an Amazon SageMaker app.
', 'refs' => [ 'AppList$member' => NULL, ], ], 'AppImageConfigArn' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigArn' => 'The Amazon Resource Name (ARN) of the AppImageConfig.
', 'CreateAppImageConfigResponse$AppImageConfigArn' => 'The Amazon Resource Name (ARN) of the AppImageConfig.
', 'DescribeAppImageConfigResponse$AppImageConfigArn' => 'The Amazon Resource Name (ARN) of the AppImageConfig.
', 'UpdateAppImageConfigResponse$AppImageConfigArn' => 'The Amazon Resource Name (ARN) for the AppImageConfig.
', ], ], 'AppImageConfigDetails' => [ 'base' => 'The configuration for running a SageMaker image as a KernelGateway app.
', 'refs' => [ 'AppImageConfigList$member' => NULL, ], ], 'AppImageConfigList' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsResponse$AppImageConfigs' => 'A list of AppImageConfigs and their properties.
', ], ], 'AppImageConfigName' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigName' => 'The name of the AppImageConfig. Must be unique to your account.
', 'CreateAppImageConfigRequest$AppImageConfigName' => 'The name of the AppImageConfig. Must be unique to your account.
', 'CustomImage$AppImageConfigName' => 'The name of the AppImageConfig.
', 'DeleteAppImageConfigRequest$AppImageConfigName' => 'The name of the AppImageConfig to delete.
', 'DescribeAppImageConfigRequest$AppImageConfigName' => 'The name of the AppImageConfig to describe.
', 'DescribeAppImageConfigResponse$AppImageConfigName' => 'The name of the AppImageConfig.
', 'ListAppImageConfigsRequest$NameContains' => 'A filter that returns only AppImageConfigs whose name contains the specified string.
', 'UpdateAppImageConfigRequest$AppImageConfigName' => 'The name of the AppImageConfig to update.
', ], ], 'AppImageConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsRequest$SortBy' => 'The property used to sort results. The default value is CreationTime.
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 list of apps.
', ], ], 'AppManaged' => [ 'base' => NULL, 'refs' => [ 'ProcessingInput$AppManaged' => '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.
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.
The name of the app.
', 'CreateAppRequest$AppName' => 'The name of the app.
', 'DeleteAppRequest$AppName' => 'The name of the app.
', 'DescribeAppRequest$AppName' => 'The name of the app.
', 'DescribeAppResponse$AppName' => 'The name of the app.
', ], ], 'AppNetworkAccessType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppNetworkAccessType' => '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, which allows direct internet access
VpcOnly - All Studio 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, which allows direct internet access
VpcOnly - All Studio traffic is through the specified VPC and subnets
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 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.
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 parameter by which to sort the results. The default is CreationTime.
', ], ], 'AppSpecification' => [ 'base' => 'Configuration to run a processing job in a specified container image.
', 'refs' => [ 'CreateProcessingJobRequest$AppSpecification' => 'Configures the processing job to run a specified Docker container image.
', 'DescribeProcessingJobResponse$AppSpecification' => 'Configures the processing job to run a specified container image.
', 'ProcessingJob$AppSpecification' => NULL, ], ], 'AppStatus' => [ 'base' => NULL, 'refs' => [ 'AppDetails$Status' => 'The status.
', 'DescribeAppResponse$Status' => 'The status.
', ], ], 'AppType' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppType' => 'The type of app.
', 'CreateAppRequest$AppType' => 'The type of app.
', 'DeleteAppRequest$AppType' => 'The type of app.
', 'DescribeAppRequest$AppType' => 'The type of app.
', 'DescribeAppResponse$AppType' => 'The type of app.
', ], ], 'ApprovalDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageOutput$ApprovalDescription' => 'A description provided for the model approval.
', 'ModelPackage$ApprovalDescription' => 'A description provided when the model approval is set.
', 'UpdateModelPackageInput$ApprovalDescription' => 'A description for the approval status of the model.
', ], ], 'ArnOrName' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$AlgorithmName' => '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.
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.
', 'DeleteModelPackageGroupInput$ModelPackageGroupName' => 'The name of the model group to delete.
', 'DescribeAlgorithmInput$AlgorithmName' => 'The name of the algorithm to describe.
', 'DescribeModelPackageGroupInput$ModelPackageGroupName' => 'The name of gthe model group to describe.
', 'HyperParameterAlgorithmSpecification$AlgorithmName' => '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.
A filter that returns only model versions that belong to the specified model group.
', 'SourceAlgorithm$AlgorithmName' => '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.
', ], ], 'ArtifactArn' => [ 'base' => NULL, 'refs' => [ 'ArtifactSummary$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', 'CreateArtifactResponse$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', 'DeleteArtifactRequest$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact to delete.
', 'DeleteArtifactResponse$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', 'DescribeArtifactRequest$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact to describe.
', 'DescribeArtifactResponse$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', 'UpdateArtifactRequest$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact to update.
', 'UpdateArtifactResponse$ArtifactArn' => 'The Amazon Resource Name (ARN) of the artifact.
', ], ], 'ArtifactDigest' => [ 'base' => NULL, 'refs' => [ 'ModelDigests$ArtifactDigest' => 'Provides a hash value that uniquely identifies the stored model artifacts.
', ], ], 'ArtifactSource' => [ 'base' => 'A structure describing the source of an artifact.
', 'refs' => [ 'ArtifactSummary$Source' => 'The source of the artifact.
', 'CreateArtifactRequest$Source' => 'The ID, ID type, and URI of the source.
', 'DeleteArtifactRequest$Source' => 'The URI of the source.
', 'DescribeArtifactResponse$Source' => 'The source of the artifact.
', ], ], 'ArtifactSourceIdType' => [ 'base' => NULL, 'refs' => [ 'ArtifactSourceType$SourceIdType' => 'The type of ID.
', ], ], 'ArtifactSourceType' => [ 'base' => 'The ID and ID type of an artifact source.
', 'refs' => [ 'ArtifactSourceTypes$member' => NULL, ], ], 'ArtifactSourceTypes' => [ 'base' => NULL, 'refs' => [ 'ArtifactSource$SourceTypes' => 'A list of source types.
', ], ], 'ArtifactSummaries' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsResponse$ArtifactSummaries' => 'A list of artifacts and their properties.
', ], ], 'ArtifactSummary' => [ 'base' => '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.
', 'refs' => [ 'ArtifactSummaries$member' => NULL, ], ], 'AssemblyType' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$AssembleWith' => '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 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.
The type of the association.
', 'Edge$AssociationType' => 'The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.
A filter that returns only associations of the specified type.
', ], ], 'AssociationEntityArn' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$SourceArn' => 'The ARN of the source.
', 'AddAssociationRequest$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'AddAssociationResponse$SourceArn' => 'The ARN of the source.
', 'AddAssociationResponse$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'AssociationSummary$SourceArn' => 'The ARN of the source.
', 'AssociationSummary$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'DeleteAssociationRequest$SourceArn' => 'The ARN of the source.
', 'DeleteAssociationRequest$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'DeleteAssociationResponse$SourceArn' => 'The ARN of the source.
', 'DeleteAssociationResponse$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination.
', 'Edge$SourceArn' => 'The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.
', 'Edge$DestinationArn' => 'The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.
', 'ListAssociationsRequest$SourceArn' => 'A filter that returns only associations with the specified source ARN.
', 'ListAssociationsRequest$DestinationArn' => 'A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
', 'QueryLineageStartArns$member' => NULL, 'Vertex$Arn' => 'The Amazon Resource Name (ARN) of the lineage entity resource.
', ], ], 'AssociationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsResponse$AssociationSummaries' => 'A list of associations and their properties.
', ], ], 'AssociationSummary' => [ 'base' => '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.
', 'refs' => [ 'AssociationSummaries$member' => NULL, ], ], 'AsyncInferenceClientConfig' => [ 'base' => 'Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
', 'refs' => [ 'AsyncInferenceConfig$ClientConfig' => 'Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
', ], ], 'AsyncInferenceConfig' => [ 'base' => 'Specifies configuration for how an endpoint performs asynchronous inference.
', 'refs' => [ 'CreateEndpointConfigInput$AsyncInferenceConfig' => 'Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
', 'DescribeEndpointConfigOutput$AsyncInferenceConfig' => 'Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Specifies the configuration for notifications of inference results for asynchronous inference.
', 'refs' => [ 'AsyncInferenceOutputConfig$NotificationConfig' => 'Specifies the configuration for notifications of inference results for asynchronous inference.
', ], ], 'AsyncInferenceOutputConfig' => [ 'base' => 'Specifies the configuration for asynchronous inference invocation outputs.
', 'refs' => [ 'AsyncInferenceConfig$OutputConfig' => 'Specifies the configuration for asynchronous inference invocation outputs.
', ], ], 'AsyncNotificationTopicTypeList' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$IncludeInferenceResponseIn' => 'The 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.
The name of the data catalog used in Athena query execution.
', 'refs' => [ 'AthenaDatasetDefinition$Catalog' => NULL, ], ], 'AthenaDatabase' => [ 'base' => 'The name of the database used in the Athena query execution.
', 'refs' => [ 'AthenaDatasetDefinition$Database' => NULL, ], ], 'AthenaDatasetDefinition' => [ 'base' => 'Configuration for Athena Dataset Definition input.
', 'refs' => [ 'DatasetDefinition$AthenaDatasetDefinition' => NULL, ], ], 'AthenaQueryString' => [ 'base' => 'The SQL query statements, to be executed.
', 'refs' => [ 'AthenaDatasetDefinition$QueryString' => NULL, ], ], 'AthenaResultCompressionType' => [ 'base' => 'The compression used for Athena query results.
', 'refs' => [ 'AthenaDatasetDefinition$OutputCompression' => NULL, ], ], 'AthenaResultFormat' => [ 'base' => 'The data storage format for Athena query results.
', 'refs' => [ 'AthenaDatasetDefinition$OutputFormat' => NULL, ], ], 'AthenaWorkGroup' => [ 'base' => 'The name of the workgroup in which the Athena query is being started.
', 'refs' => [ 'AthenaDatasetDefinition$WorkGroup' => NULL, ], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'AttributeNames$member' => NULL, ], ], 'AttributeNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$AttributeNames' => 'A list of one or more attribute names to use that are found in a specified augmented manifest file.
', ], ], 'AuthMode' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AuthMode' => 'The mode of authentication that members use to access the domain.
', 'DescribeDomainResponse$AuthMode' => 'The domain\'s authentication mode.
', ], ], 'AutoGenerateEndpointName' => [ 'base' => NULL, 'refs' => [ 'ModelDeployConfig$AutoGenerateEndpointName' => '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.
The collection of algorithms run on a dataset for training the model candidates of an Autopilot job.
', 'refs' => [ 'AutoMLAlgorithmsConfig$member' => NULL, ], ], 'AutoMLAlgorithms' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithmConfig$AutoMLAlgorithms' => 'The selection of algorithms run on a dataset to train the model candidates of an Autopilot job.
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"
Stores the configuration information for the selection of algorithms used to train the model candidates.
The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .
AlgorithmsConfig should not be set in AUTO training mode.
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, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.
When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.
For the list of all algorithms per training mode, see AutoMLAlgorithmConfig.
For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.
', 'CandidateGenerationConfig$AlgorithmsConfig' => 'Stores the configuration information for the selection of algorithms used to train model candidates 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 in AUTO training mode.
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.
', ], ], 'AutoMLCandidate' => [ 'base' => 'Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.
', 'refs' => [ 'AutoMLCandidates$member' => NULL, 'DescribeAutoMLJobResponse$BestCandidate' => 'The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.
', 'DescribeAutoMLJobV2Response$BestCandidate' => 'Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.
', ], ], 'AutoMLCandidateGenerationConfig' => [ 'base' => 'Stores the configuration information for how a candidate is generated (optional).
', 'refs' => [ 'AutoMLJobConfig$CandidateGenerationConfig' => 'The configuration for generating a candidate for an AutoML job (optional).
', ], ], 'AutoMLCandidateStep' => [ 'base' => 'Information about the steps for a candidate and what step it is working on.
', 'refs' => [ 'CandidateSteps$member' => NULL, ], ], 'AutoMLCandidates' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobResponse$Candidates' => 'Summaries about the AutoMLCandidates.
A 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 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.
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.
A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.
', 'refs' => [ 'AutoMLContainerDefinitions$member' => NULL, ], ], 'AutoMLContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$InferenceContainers' => 'Information about the recommended inference container definitions.
', 'AutoMLInferenceContainerDefinitions$value' => 'Information about the recommended inference container definitions.
', ], ], 'AutoMLDataSource' => [ 'base' => 'The data source for the Autopilot job.
', 'refs' => [ 'AutoMLChannel$DataSource' => 'The data source for an AutoML channel.
', 'AutoMLJobChannel$DataSource' => 'The data source for an AutoML channel (Required).
', ], ], 'AutoMLDataSplitConfig' => [ 'base' => '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.
The configuration for splitting the input training dataset.
Type: AutoMLDataSplitConfig
', 'CreateAutoMLJobV2Request$DataSplitConfig' => '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.
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.
Returns the configuration settings of how the data are split into train and validation datasets.
', ], ], 'AutoMLFailureReason' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$FailureReason' => 'The failure reason.
', 'AutoMLJobSummary$FailureReason' => 'The failure reason of an AutoML job.
', 'AutoMLPartialFailureReason$PartialFailureMessage' => 'The message containing the reason for a partial failure of an AutoML job.
', 'DescribeAutoMLJobResponse$FailureReason' => 'Returns the failure reason for an AutoML job, when applicable.
', 'DescribeAutoMLJobV2Response$FailureReason' => 'Returns the reason for the failure of the AutoML job V2, when applicable.
', ], ], 'AutoMLInferenceContainerDefinitions' => [ 'base' => '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 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.
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.
Returns the input data configuration for the AutoML job.
', ], ], 'AutoMLJobArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the AutoML job.
', 'AutoMLJobSummary$AutoMLJobArn' => 'The ARN of the AutoML job.
', 'CreateAutoMLJobResponse$AutoMLJobArn' => 'The unique ARN assigned to the AutoML job when it is created.
', 'CreateAutoMLJobV2Response$AutoMLJobArn' => 'The unique ARN assigned to the AutoMLJob when it is created.
', 'DescribeAutoMLJobResponse$AutoMLJobArn' => 'Returns the ARN of the AutoML job.
', 'DescribeAutoMLJobV2Response$AutoMLJobArn' => 'Returns the Amazon Resource Name (ARN) of the AutoML job V2.
', 'DescribeProcessingJobResponse$AutoMLJobArn' => 'The ARN of an AutoML job associated with this processing job.
', 'DescribeTrainingJobResponse$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of an AutoML job.
', 'DescribeTransformJobResponse$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of the AutoML transform job.
', 'ProcessingJob$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
', 'TrainingJob$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of the job.
', 'TransformJob$AutoMLJobArn' => 'The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
', ], ], 'AutoMLJobArtifacts' => [ 'base' => 'The artifacts that are generated during an AutoML job.
', 'refs' => [ 'DescribeAutoMLJobResponse$AutoMLJobArtifacts' => 'Returns information on the job\'s artifacts found in AutoMLJobArtifacts.
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).
', 'refs' => [ 'AutoMLJobInputDataConfig$member' => NULL, ], ], 'AutoMLJobCompletionCriteria' => [ 'base' => 'How long a job is allowed to run, or how many candidates a job is allowed to generate.
', 'refs' => [ 'AutoMLJobConfig$CompletionCriteria' => 'How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.
', 'AutoMLResolvedAttributes$CompletionCriteria' => NULL, 'ImageClassificationJobConfig$CompletionCriteria' => 'How long a job is allowed to run, or how many candidates a job is allowed to generate.
', 'ResolvedAttributes$CompletionCriteria' => NULL, 'TabularJobConfig$CompletionCriteria' => NULL, 'TextClassificationJobConfig$CompletionCriteria' => 'How long a job is allowed to run, or how many candidates a job is allowed to generate.
', 'TimeSeriesForecastingJobConfig$CompletionCriteria' => NULL, ], ], 'AutoMLJobConfig' => [ 'base' => 'A collection of settings used for an AutoML job.
', 'refs' => [ 'CreateAutoMLJobRequest$AutoMLJobConfig' => 'A collection of settings used to configure an AutoML job.
', 'DescribeAutoMLJobResponse$AutoMLJobConfig' => 'Returns the configuration for the AutoML job.
', ], ], 'AutoMLJobInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLJobInputDataConfig' => '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.
Returns an array of channel objects describing the input data and their location.
', ], ], 'AutoMLJobName' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobName' => 'The name of the AutoML job you are requesting.
', 'CreateAutoMLJobRequest$AutoMLJobName' => 'Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
', 'CreateAutoMLJobV2Request$AutoMLJobName' => 'Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
', 'DescribeAutoMLJobRequest$AutoMLJobName' => 'Requests information about an AutoML job using its unique name.
', 'DescribeAutoMLJobResponse$AutoMLJobName' => 'Returns the name of the AutoML job.
', 'DescribeAutoMLJobV2Request$AutoMLJobName' => 'Requests information about an AutoML job V2 using its unique name.
', 'DescribeAutoMLJobV2Response$AutoMLJobName' => 'Returns the name of the AutoML job V2.
', 'ListCandidatesForAutoMLJobRequest$AutoMLJobName' => 'List the candidates created for the job by providing the job\'s name.
', 'StopAutoMLJobRequest$AutoMLJobName' => 'The name of the object you are requesting.
', ], ], 'AutoMLJobObjective' => [ 'base' => 'Specifies a metric to minimize or maximize as the objective of a job.
', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLJobObjective' => NULL, 'CreateAutoMLJobRequest$AutoMLJobObjective' => '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.
', 'CreateAutoMLJobV2Request$AutoMLJobObjective' => '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.
Returns the job\'s objective.
', 'DescribeAutoMLJobV2Response$AutoMLJobObjective' => 'Returns the job\'s objective.
', 'ResolvedAttributes$AutoMLJobObjective' => NULL, ], ], 'AutoMLJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Type' => 'The type of metric with the best result.
', ], ], 'AutoMLJobSecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobSecondaryStatus' => 'The secondary status of the AutoML job.
', 'DescribeAutoMLJobResponse$AutoMLJobSecondaryStatus' => 'Returns the secondary status of the AutoML job.
', 'DescribeAutoMLJobV2Response$AutoMLJobSecondaryStatus' => 'Returns the secondary status of the AutoML job V2.
', ], ], 'AutoMLJobStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobStatus' => 'The status of the AutoML job.
', 'DescribeAutoMLJobResponse$AutoMLJobStatus' => 'Returns the status of the AutoML job.
', 'DescribeAutoMLJobV2Response$AutoMLJobStatus' => 'Returns the status of the AutoML job V2.
', 'ListAutoMLJobsRequest$StatusEquals' => 'Request a list of jobs, using a filter for status.
', ], ], 'AutoMLJobStepMetadata' => [ 'base' => 'Metadata for an AutoML job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$AutoMLJob' => 'The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
', ], ], 'AutoMLJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsResponse$AutoMLJobSummaries' => 'Returns a summary list of jobs.
', ], ], 'AutoMLJobSummary' => [ 'base' => 'Provides a summary about an AutoML job.
', 'refs' => [ 'AutoMLJobSummaries$member' => NULL, ], ], 'AutoMLMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$MaxResults' => 'Request a list of jobs up to a specified limit.
', 'ListCandidatesForAutoMLJobRequest$MaxResults' => 'List the job\'s candidates up to a specified limit.
', ], ], 'AutoMLMetricEnum' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobObjective$MetricName' => '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.
For the list of all available metrics supported by Autopilot, see Autopilot metrics.
If you do not specify a metric explicitly, the default behavior is to automatically use:
For tabular problem types:
Regression: MSE.
Binary classification: F1.
Multiclass classification: Accuracy.
For image or text classification problem types: Accuracy
For time-series forecasting problem types: AverageWeightedQuantileLoss
The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
', 'FinalAutoMLJobObjectiveMetric$StandardMetricName' => 'The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
', 'MetricDatum$MetricName' => 'The name of the metric.
', ], ], 'AutoMLMetricExtendedEnum' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$StandardMetricName' => 'The name of the standard metric.
For definitions of the standard metrics, see Autopilot candidate metrics .
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 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.
Request a list of jobs, using a search filter for name.
', ], ], 'AutoMLOutputDataConfig' => [ 'base' => 'The output data configuration.
', 'refs' => [ 'CreateAutoMLJobRequest$OutputDataConfig' => 'Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.
', 'CreateAutoMLJobV2Request$OutputDataConfig' => 'Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.
', 'DescribeAutoMLJobResponse$OutputDataConfig' => 'Returns the job\'s output data config.
', 'DescribeAutoMLJobV2Response$OutputDataConfig' => 'Returns the job\'s output data config.
', ], ], 'AutoMLPartialFailureReason' => [ 'base' => 'The reason for a partial failure of an AutoML job.
', 'refs' => [ 'AutoMLPartialFailureReasons$member' => NULL, ], ], 'AutoMLPartialFailureReasons' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$PartialFailureReasons' => 'The list of reasons for partial failures within an AutoML job.
', 'DescribeAutoMLJobResponse$PartialFailureReasons' => 'Returns a list of reasons for partial failures within an AutoML job.
', 'DescribeAutoMLJobV2Response$PartialFailureReasons' => 'Returns a list of reasons for partial failures within an AutoML job V2.
', ], ], 'AutoMLProblemTypeConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLProblemTypeConfig' => 'Defines the configuration settings of one of the supported problem types.
', 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfig' => 'Returns the configuration settings of the problem type set for the AutoML job V2.
', ], ], 'AutoMLProblemTypeConfigName' => [ 'base' => NULL, 'refs' => [ 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfigName' => 'Returns the name of the problem type configuration set for the AutoML job V2.
', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'base' => 'The resolved attributes specific to the problem type of an AutoML job V2.
', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLProblemTypeResolvedAttributes' => 'Defines the resolved attributes specific to a problem type.
', ], ], 'AutoMLProcessingUnit' => [ 'base' => NULL, 'refs' => [ 'AutoMLInferenceContainerDefinitions$key' => 'Processing unit for an inference container. Currently Autopilot only supports CPU or GPU.
The resolved attributes used to configure an AutoML job V2.
', 'refs' => [ 'DescribeAutoMLJobV2Response$ResolvedAttributes' => 'Returns the resolved attributes used by the AutoML job V2.
', ], ], 'AutoMLS3DataSource' => [ 'base' => 'Describes the Amazon S3 data source.
', 'refs' => [ 'AutoMLDataSource$S3DataSource' => 'The Amazon S3 location of the input data.
', ], ], 'AutoMLS3DataType' => [ 'base' => NULL, 'refs' => [ 'AutoMLS3DataSource$S3DataType' => 'The data type.
If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker 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 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.
Security options.
', 'refs' => [ 'AutoMLJobConfig$SecurityConfig' => 'The security configuration for traffic encryption or Amazon VPC settings.
', 'CreateAutoMLJobV2Request$SecurityConfig' => 'The security configuration for traffic encryption or Amazon VPC settings.
', 'DescribeAutoMLJobV2Response$SecurityConfig' => 'Returns the security configuration for traffic encryption or Amazon VPC settings.
', ], ], 'AutoMLSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortBy' => 'The parameter by which to sort the results. The default is Name.
The sort order for the results. The default is Descending.
The sort order for the results. The default is Ascending.
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.
', 'refs' => [ 'AutoParameters$member' => NULL, ], ], 'AutoParameters' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$AutoParameters' => 'A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.
', ], ], 'AutoRollbackConfig' => [ 'base' => 'Automatic rollback configuration for handling endpoint deployment failures and recovery.
', 'refs' => [ 'DeploymentConfig$AutoRollbackConfiguration' => 'Automatic rollback configuration for handling endpoint deployment failures and recovery.
', ], ], 'Autotune' => [ 'base' => 'A 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.
Configures 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.
A flag to indicate if autotune is enabled for the hyperparameter tuning job.
', ], ], 'AutotuneMode' => [ 'base' => NULL, 'refs' => [ 'Autotune$Mode' => 'Set Mode to Enabled if you want to use Autotune.
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:
', ], ], 'BacktestResultsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$BacktestResults' => '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.
', ], ], 'BatchDataCaptureConfig' => [ 'base' => 'Configuration to control how SageMaker captures inference data for batch transform jobs.
', 'refs' => [ 'CreateTransformJobRequest$DataCaptureConfig' => 'Configuration to control how SageMaker captures inference data.
', 'DescribeTransformJobResponse$DataCaptureConfig' => 'Configuration to control how SageMaker captures inference data.
', ], ], 'BatchDescribeModelPackageError' => [ 'base' => 'The error code and error description associated with the resource.
', 'refs' => [ 'BatchDescribeModelPackageErrorMap$value' => NULL, ], ], 'BatchDescribeModelPackageErrorMap' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$BatchDescribeModelPackageErrorMap' => 'A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.
', ], ], 'BatchDescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageSummary' => [ 'base' => 'Provides summary information about the model package.
', 'refs' => [ 'ModelPackageSummaries$value' => NULL, ], ], 'BatchStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$BatchStrategy' => '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.
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.
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.
', 'TransformJobDefinition$BatchStrategy' => '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.
Input object for the batch transform job.
', 'refs' => [ 'DataQualityJobInput$BatchTransformInput' => 'Input object for the batch transform job.
', 'ModelBiasJobInput$BatchTransformInput' => 'Input object for the batch transform job.
', 'ModelExplainabilityJobInput$BatchTransformInput' => 'Input object for the batch transform job.
', 'ModelQualityJobInput$BatchTransformInput' => 'Input object for the batch transform job.
', 'MonitoringInput$BatchTransformInput' => 'Input object for the batch transform job.
', ], ], 'BestObjectiveNotImproving' => [ 'base' => '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.
', 'refs' => [ 'TuningJobCompletionCriteria$BestObjectiveNotImproving' => 'A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.
', ], ], 'Bias' => [ 'base' => 'Contains bias metrics for a model.
', 'refs' => [ 'ModelMetrics$Bias' => 'Metrics that measure bais in a model.
', ], ], 'BillableTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$BillableTimeInSeconds' => '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%.
The billable time in seconds.
', ], ], 'BlockedReason' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreStatus$BlockedReason' => 'The justification for why the OfflineStoreStatus is Blocked (if applicable).
', ], ], 'BlueGreenUpdatePolicy' => [ 'base' => '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.
', 'refs' => [ 'DeploymentConfig$BlueGreenUpdatePolicy' => '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.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$EnableSageMakerMetricsTimeSeries' => 'To 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
Whether to use traffic encryption between the container layers.
', 'BatchDataCaptureConfig$GenerateInferenceId' => 'Flag that indicates whether to append inference id to the output.
', 'ChannelSpecification$IsRequired' => 'Indicates whether the channel is required by the algorithm.
', 'ClarifyCheckStepMetadata$SkipCheck' => '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 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.
Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
', 'CreateTrainingJobRequest$EnableNetworkIsolation' => '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.
', 'CreateTrainingJobRequest$EnableInterContainerTrafficEncryption' => '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 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.
', 'DescribeModelOutput$EnableNetworkIsolation' => 'If True, no inbound or outbound network calls can be made to or from the model container.
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, 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 not (False).
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
', 'HyperParameterSpecification$IsRequired' => 'Indicates whether this hyperparameter is required.
', 'HyperParameterTrainingJobDefinition$EnableNetworkIsolation' => '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.
', 'HyperParameterTrainingJobDefinition$EnableInterContainerTrafficEncryption' => '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 not (False).
Toggle for excluding devices deployed in other stages.
', 'Model$EnableNetworkIsolation' => 'Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
', 'ModelDashboardIndicatorAction$Enabled' => 'Indicates whether the alert action is turned on.
', 'MonitoringCsvDatasetFormat$Header' => 'Indicates if the CSV data has a header.
', 'MonitoringJsonDatasetFormat$Line' => 'Indicates if the file should be read as a json object per line.
', 'MonitoringNetworkConfig$EnableInterContainerTrafficEncryption' => '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 the monitoring job.
', 'NetworkConfig$EnableInterContainerTrafficEncryption' => '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 the processing job.
', 'OfflineStoreConfig$DisableGlueTableCreation' => '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.
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.
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 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.
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.
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, 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 training jobs instead of on-demand instances. For more information, see Managed Spot Training.
', 'TrainingSpecification$SupportsDistributedTraining' => 'Indicates whether the algorithm supports distributed training. If set to false, buyers can\'t request more than one instance during training.
', 'UpdateEndpointInput$RetainAllVariantProperties' => '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.
Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
', ], ], 'BooleanOperator' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$Operator' => '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.
The default branch for the Git repository.
', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$Bucket' => 'Name of the S3 bucket.
', ], ], 'CacheHitResult' => [ 'base' => 'Details on the cache hit of a pipeline execution step.
', 'refs' => [ 'PipelineExecutionStep$CacheHitResult' => 'If this pipeline execution step was cached, details on the cache hit.
', ], ], 'CallbackStepMetadata' => [ 'base' => 'Metadata about a callback step.
', 'refs' => [ 'PipelineExecutionStepMetadata$Callback' => 'The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.
', ], ], 'CallbackToken' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$CallbackToken' => 'The pipeline generated token from the Amazon SQS queue.
', 'SendPipelineExecutionStepFailureRequest$CallbackToken' => 'The pipeline generated token from the Amazon SQS queue.
', 'SendPipelineExecutionStepSuccessRequest$CallbackToken' => 'The pipeline generated token from the Amazon SQS queue.
', ], ], 'CandidateArtifactLocations' => [ 'base' => 'The location of artifacts for an AutoML candidate job.
', 'refs' => [ 'CandidateProperties$CandidateArtifactLocations' => 'The Amazon S3 prefix to the artifacts generated for an AutoML candidate.
', ], ], 'CandidateDefinitionNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$CandidateDefinitionNotebookLocation' => 'The URL of the notebook location.
', ], ], 'CandidateGenerationConfig' => [ 'base' => 'Stores the configuration information for how model candidates are generated using an AutoML job V2.
', 'refs' => [ 'TabularJobConfig$CandidateGenerationConfig' => 'The configuration information of how model candidates are generated.
', ], ], 'CandidateName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateName' => 'The name of the candidate.
', 'ListCandidatesForAutoMLJobRequest$CandidateNameEquals' => 'List the candidates for the job and filter by candidate name.
', ], ], 'CandidateProperties' => [ 'base' => 'The properties of an AutoML candidate job.
', 'refs' => [ 'AutoMLCandidate$CandidateProperties' => 'The properties of an AutoML candidate job.
', ], ], 'CandidateSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$SortBy' => 'The parameter by which to sort the results. The default is Descending.
The candidate\'s status.
', 'ListCandidatesForAutoMLJobRequest$StatusEquals' => 'List the candidates for the job and filter by status.
', ], ], 'CandidateStepArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepArn' => 'The ARN for the candidate\'s step.
', ], ], 'CandidateStepName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepName' => 'The name for the candidate\'s step.
', ], ], 'CandidateStepType' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepType' => 'Whether the candidate is at the transform, training, or processing step.
', ], ], 'CandidateSteps' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateSteps' => 'Information about the candidate\'s steps.
', ], ], 'CanvasAppSettings' => [ 'base' => 'The SageMaker Canvas application settings.
', 'refs' => [ 'UserSettings$CanvasAppSettings' => 'The Canvas app settings.
', ], ], 'CapacitySize' => [ 'base' => '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.
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.
', 'RollingUpdatePolicy$RollbackMaximumBatchSize' => '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.
', 'TrafficRoutingConfig$CanarySize' => '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. Value must be 10-50% of the variant\'s total instance count.
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 percentage.
', ], ], 'CaptureContentTypeHeader' => [ 'base' => 'Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.
', 'refs' => [ 'DataCaptureConfig$CaptureContentTypeHeader' => 'Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.
', 'InferenceExperimentDataStorageConfig$ContentType' => NULL, ], ], 'CaptureMode' => [ 'base' => NULL, 'refs' => [ 'CaptureOption$CaptureMode' => 'Specify the boundary of data to capture.
', ], ], 'CaptureOption' => [ 'base' => 'Specifies data Model Monitor will capture.
', 'refs' => [ 'CaptureOptionList$member' => NULL, ], ], 'CaptureOptionList' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$CaptureOptions' => 'Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both
', ], ], 'CaptureStatus' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfigSummary$CaptureStatus' => 'Whether data capture is currently functional.
', ], ], 'Catalog' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Catalog' => 'The name of the Glue table catalog.
', ], ], 'CategoricalParameter' => [ 'base' => 'Environment parameters you want to benchmark your load test against.
', 'refs' => [ 'CategoricalParameters$member' => NULL, ], ], 'CategoricalParameterRange' => [ 'base' => 'A list of categorical hyperparameters to tune.
', 'refs' => [ 'CategoricalParameterRanges$member' => NULL, ], ], 'CategoricalParameterRangeSpecification' => [ 'base' => 'Defines the possible values for a categorical hyperparameter.
', 'refs' => [ 'ParameterRange$CategoricalParameterRangeSpecification' => 'A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.
The list of values you can pass.
', ], ], 'CategoricalParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$CategoricalParameterRanges' => 'The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
', ], ], 'CategoricalParameters' => [ 'base' => NULL, 'refs' => [ 'EnvironmentParameterRanges$CategoricalParameterRanges' => 'Specified a list of parameters for each category.
', ], ], 'Cents' => [ 'base' => NULL, 'refs' => [ 'USD$Cents' => 'The fractional portion, in cents, of the amount.
', ], ], 'CertifyForMarketplace' => [ 'base' => NULL, 'refs' => [ 'CreateAlgorithmInput$CertifyForMarketplace' => 'Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.
', 'CreateModelPackageInput$CertifyForMarketplace' => '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.
', 'DescribeAlgorithmOutput$CertifyForMarketplace' => 'Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.
', 'DescribeModelPackageOutput$CertifyForMarketplace' => 'Whether the model package is certified for listing on Amazon Web Services Marketplace.
', 'ModelPackage$CertifyForMarketplace' => '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.
', ], ], 'Channel' => [ 'base' => 'A channel is a named input source that training algorithms can consume.
', 'refs' => [ 'InputDataConfig$member' => NULL, ], ], 'ChannelName' => [ 'base' => NULL, 'refs' => [ 'Channel$ChannelName' => 'The name of the channel.
', 'ChannelSpecification$Name' => 'The name of the channel.
', ], ], 'ChannelSpecification' => [ 'base' => 'Defines a named input source, called a channel, to be used by an algorithm.
', 'refs' => [ 'ChannelSpecifications$member' => NULL, ], ], 'ChannelSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$TrainingChannels' => 'A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.
Contains information about the output location for managed spot training checkpoint data.
', 'refs' => [ 'CreateTrainingJobRequest$CheckpointConfig' => 'Contains information about the output location for managed spot training checkpoint data.
', 'DescribeTrainingJobResponse$CheckpointConfig' => NULL, 'HyperParameterTrainingJobDefinition$CheckpointConfig' => NULL, 'TrainingJob$CheckpointConfig' => NULL, ], ], 'Cidr' => [ 'base' => NULL, 'refs' => [ 'Cidrs$member' => NULL, ], ], 'Cidrs' => [ 'base' => NULL, 'refs' => [ 'SourceIpConfig$Cidrs' => 'A 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.
The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.
', 'refs' => [ 'PipelineExecutionStepMetadata$ClarifyCheck' => '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.
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.
A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.
The configuration parameters for the SageMaker Clarify explainer.
', 'refs' => [ 'ExplainerConfig$ClarifyExplainerConfig' => 'A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.
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 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.
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]}\'.
The inference configuration parameter for the model container.
', 'refs' => [ 'ClarifyExplainerConfig$InferenceConfig' => 'The inference configuration parameter for the model container.
', ], ], 'ClarifyLabelAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelAttribute' => '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 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.
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\'].
The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.
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 MIME type of the baseline data. Choose from \'text/csv\' or \'application/jsonlines\'. Defaults to \'text/csv\'.
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 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].
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 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 configuration for the SHAP baseline of the Kernal SHAP algorithm.
', ], ], 'ClarifyShapConfig' => [ 'base' => 'The configuration for SHAP analysis using SageMaker Clarify Explainer.
', 'refs' => [ 'ClarifyExplainerConfig$ShapConfig' => 'The configuration for SHAP analysis.
', ], ], 'ClarifyShapNumberOfSamples' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$NumberOfSamples' => 'The 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.
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.
', ], ], 'ClarifyShapUseLogit' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$UseLogit' => '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.
', ], ], 'ClarifyTextConfig' => [ 'base' => '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.
', 'refs' => [ 'ClarifyShapConfig$TextConfig' => '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.
', ], ], 'ClarifyTextGranularity' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Granularity' => '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.
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 client ID for your Amazon Cognito user pool.
', 'CognitoMemberDefinition$ClientId' => 'An identifier for an application client. You must create the app client ID using Amazon Cognito.
', 'OidcConfig$ClientId' => 'The OIDC IdP client ID used to configure your private workforce.
', 'OidcConfigForResponse$ClientId' => 'The OIDC IdP client ID used to configure your private workforce.
', ], ], 'ClientSecret' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$ClientSecret' => 'The OIDC IdP client secret used to configure your private workforce.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ClientToken' => '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.
', 'CreateModelPackageInput$ClientToken' => 'A unique token that guarantees that the call to this API is idempotent.
', ], ], 'CodeRepositories' => [ 'base' => NULL, 'refs' => [ 'JupyterServerAppSettings$CodeRepositories' => 'A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.
', ], ], 'CodeRepository' => [ 'base' => 'A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.
', 'refs' => [ 'CodeRepositories$member' => NULL, ], ], 'CodeRepositoryArn' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$CodeRepositoryArn' => 'The Amazon Resource Name (ARN) of the Git repository.
', 'CreateCodeRepositoryOutput$CodeRepositoryArn' => 'The Amazon Resource Name (ARN) of the new repository.
', 'DescribeCodeRepositoryOutput$CodeRepositoryArn' => 'The Amazon Resource Name (ARN) of the Git repository.
', 'UpdateCodeRepositoryOutput$CodeRepositoryArn' => 'The ARN of the Git repository.
', ], ], 'CodeRepositoryContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$DefaultCodeRepositoryContains' => '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.
', ], ], 'CodeRepositoryNameContains' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$NameContains' => 'A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.
', ], ], 'CodeRepositoryNameOrUrl' => [ 'base' => NULL, 'refs' => [ 'AdditionalCodeRepositoryNamesOrUrls$member' => NULL, 'CreateNotebookInstanceInput$DefaultCodeRepository' => '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 Notebook Instances.
', 'DescribeNotebookInstanceOutput$DefaultCodeRepository' => '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 Notebook Instances.
', 'ListNotebookInstancesInput$AdditionalCodeRepositoryEquals' => 'A filter that returns only notebook instances with associated with the specified git repository.
', 'NotebookInstanceSummary$DefaultCodeRepository' => '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 Notebook Instances.
', 'UpdateNotebookInstanceInput$DefaultCodeRepository' => '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 Notebook Instances.
', ], ], 'CodeRepositorySortBy' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortBy' => 'The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
Specifies summary information about a Git repository.
', 'refs' => [ 'CodeRepositorySummaryList$member' => NULL, ], ], 'CodeRepositorySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesOutput$CodeRepositorySummaryList' => 'Gets 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.
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.
', 'refs' => [ 'CreateWorkforceRequest$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.
The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
', ], ], 'CognitoMemberDefinition' => [ 'base' => 'Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.
', 'refs' => [ 'MemberDefinition$CognitoMemberDefinition' => 'The Amazon Cognito user group that is part of the work team.
', ], ], 'CognitoUserGroup' => [ 'base' => NULL, 'refs' => [ 'CognitoMemberDefinition$UserGroup' => 'An identifier for a user group.
', ], ], 'CognitoUserPool' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$UserPool' => '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.
', 'CognitoMemberDefinition$UserPool' => 'An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
', ], ], 'CollectionConfiguration' => [ 'base' => 'Configuration information for the Amazon SageMaker Debugger output tensor collections.
', 'refs' => [ 'CollectionConfigurations$member' => NULL, ], ], 'CollectionConfigurations' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$CollectionConfigurations' => '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.
The name of the tensor collection. The name must be unique relative to other rule configuration names.
', ], ], 'CollectionParameters' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionParameters' => 'Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".
The Amazon Resource Name (ARN) of the model compilation job.
', 'CreateCompilationJobResponse$CompilationJobArn' => 'If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:
CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.
The Amazon Resource Name (ARN) of the model compilation job.
', ], ], 'CompilationJobStatus' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobStatus' => 'The status of the model compilation job.
', 'DescribeCompilationJobResponse$CompilationJobStatus' => 'The status of the model compilation job.
', 'ListCompilationJobsRequest$StatusEquals' => 'A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.
An array of CompilationJobSummary objects, each describing a model compilation job.
', ], ], 'CompilationJobSummary' => [ 'base' => 'A summary of a model compilation job.
', 'refs' => [ 'CompilationJobSummaries$member' => NULL, ], ], 'CompilerOptions' => [ 'base' => NULL, 'refs' => [ 'OutputConfig$CompilerOptions' => '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.
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.
EIA: Compilation for the Elastic Inference Accelerator supports the following compiler options:
precision_mode: Specifies the precision of compiled artifacts. Supported values are "FP16" and "FP32". Default is "FP32".
signature_def_key: Specifies the signature to use for models in SavedModel format. Defaults is TensorFlow\'s default signature def key.
output_names: Specifies a list of output tensor names for models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.
For example: {"precision_mode": "FP32", "output_names": ["output:0"]}
A flag to stop a tuning job once AMT has detected that the job has converged.
', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$CompressionType' => 'You can use Gzip or None. The default value is 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.
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.
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 allowed compression types, if data compression is used.
', ], ], 'ConditionOutcome' => [ 'base' => NULL, 'refs' => [ 'ConditionStepMetadata$Outcome' => 'The outcome of the Condition step evaluation.
', ], ], 'ConditionStepMetadata' => [ 'base' => 'Metadata for a Condition step.
', 'refs' => [ 'PipelineExecutionStepMetadata$Condition' => 'The outcome of the condition evaluation that was run by this step execution.
', ], ], 'ConfigKey' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$key' => NULL, 'HookParameters$key' => NULL, 'ProfilingParameters$key' => NULL, 'RuleParameters$key' => NULL, ], ], 'ConfigValue' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$value' => NULL, 'HookParameters$value' => NULL, 'ProfilingParameters$value' => NULL, 'RuleParameters$value' => NULL, ], ], 'ConflictException' => [ 'base' => 'There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
The arguments for a container used to run a processing job.
', ], ], 'ContainerDefinition' => [ 'base' => 'Describes the container, as part of model definition.
', 'refs' => [ 'ContainerDefinitionList$member' => NULL, 'CreateModelInput$PrimaryContainer' => '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.
', 'DescribeModelOutput$PrimaryContainer' => 'The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
', 'Model$PrimaryContainer' => NULL, ], ], 'ContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$Containers' => 'Specifies the containers in the inference pipeline.
', 'DescribeModelOutput$Containers' => 'The containers in the inference pipeline.
', 'Model$Containers' => 'The containers in the inference pipeline.
', ], ], 'ContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerEntrypoint' => 'The entrypoint for a container used to run a processing job.
', 'DataQualityAppSpecification$ContainerEntrypoint' => 'The entrypoint for a container used to run a monitoring job.
', 'ModelQualityAppSpecification$ContainerEntrypoint' => 'Specifies the entrypoint for a container that the monitoring job runs.
', 'MonitoringAppSpecification$ContainerEntrypoint' => 'Specifies the entrypoint for a container used to run the monitoring job.
', ], ], 'ContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'ContainerEntrypoint$member' => NULL, ], ], 'ContainerHostname' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ContainerHostname' => '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 DNS host name for the Docker container.
', ], ], 'ContainerImage' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Image' => 'The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.
', 'ContainerDefinition$Image' => 'The 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.
The image path you specified when you created the model.
', 'DeployedImage$ResolvedImage' => 'The specific digest path of the image hosted in this ProductionVariant.
The Amazon EC2 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.
The Amazon ECR registry path of the Docker image that contains the training algorithm.
', ], ], 'ContainerMode' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$Mode' => 'Whether the container hosts a single model or multiple models.
', ], ], 'ContentClassifier' => [ 'base' => NULL, 'refs' => [ 'ContentClassifiers$member' => NULL, ], ], 'ContentClassifiers' => [ 'base' => NULL, 'refs' => [ 'LabelingJobDataAttributes$ContentClassifiers' => '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.
', ], ], 'ContentColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$ContentColumn' => 'The name of the column used to provide the sentences to be classified. It should not be the same as the target column.
', ], ], 'ContentDigest' => [ 'base' => NULL, 'refs' => [ 'FileSource$ContentDigest' => 'The digest of the file source.
', 'MetricsSource$ContentDigest' => 'The hash key used for the metrics source.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ContentType' => '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 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.
The MIME type of the data.
', 'ContentTypes$member' => NULL, 'FileSource$ContentType' => 'The type of content stored in the file source.
', 'MetricsSource$ContentType' => 'The metric source content type.
', 'TransformInput$ContentType' => '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.
', ], ], 'ContentTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedContentTypes' => 'The supported MIME types for the input data.
', 'ChannelSpecification$SupportedContentTypes' => 'The supported MIME types for the data.
', 'InferenceSpecification$SupportedContentTypes' => 'The supported MIME types for the input data.
', ], ], 'ContextArn' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', 'CreateContextResponse$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', 'DeleteContextResponse$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', 'DescribeContextResponse$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', 'UpdateContextResponse$ContextArn' => 'The Amazon Resource Name (ARN) of the context.
', ], ], 'ContextSource' => [ 'base' => 'A structure describing the source of a context.
', 'refs' => [ 'ContextSummary$Source' => 'The source of the context.
', 'CreateContextRequest$Source' => 'The source type, ID, and URI.
', 'DescribeContextResponse$Source' => 'The source of the context.
', ], ], 'ContextSummaries' => [ 'base' => NULL, 'refs' => [ 'ListContextsResponse$ContextSummaries' => 'A list of contexts and their properties.
', ], ], 'ContextSummary' => [ 'base' => 'Lists a summary of the properties of a context. A context provides a logical grouping of other entities.
', 'refs' => [ 'ContextSummaries$member' => NULL, ], ], 'ContinuousParameterRange' => [ 'base' => 'A list of continuous hyperparameters to tune.
', 'refs' => [ 'ContinuousParameterRanges$member' => NULL, ], ], 'ContinuousParameterRangeSpecification' => [ 'base' => 'Defines the possible values for a continuous hyperparameter.
', 'refs' => [ 'ParameterRange$ContinuousParameterRangeSpecification' => 'A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.
The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
', ], ], 'ConvergenceDetected' => [ 'base' => '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.
', 'refs' => [ 'TuningJobCompletionCriteria$ConvergenceDetected' => '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.
', ], ], 'CreateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$CreationTime' => 'A timestamp that shows when the algorithm was created.
', 'AppDetails$CreationTime' => 'The creation time.
', 'BatchDescribeModelPackageSummary$CreationTime' => 'The creation time of the mortgage package summary.
', 'CodeRepositorySummary$CreationTime' => 'The date and time that the Git repository was created.
', 'CompilationJobSummary$CreationTime' => 'The time when the model compilation job was created.
', 'DescribeAlgorithmOutput$CreationTime' => 'A timestamp specifying when the algorithm was created.
', 'DescribeAppResponse$CreationTime' => 'The creation time.
', 'DescribeCodeRepositoryOutput$CreationTime' => 'The date and time that the repository was created.
', 'DescribeCompilationJobResponse$CreationTime' => 'The time that the model compilation job was created.
', 'DescribeDomainResponse$CreationTime' => 'The creation time.
', 'DescribeFeatureGroupResponse$CreationTime' => 'A timestamp indicating when SageMaker created the FeatureGroup.
A timestamp indicating when the feature was created.
', 'DescribeInferenceRecommendationsJobResponse$CreationTime' => 'A timestamp that shows when the job was created.
', 'DescribeModelPackageGroupOutput$CreationTime' => 'The time that the model group was created.
', 'DescribeModelPackageOutput$CreationTime' => 'A timestamp specifying when the model package was created.
', 'DescribeNotebookInstanceLifecycleConfigOutput$CreationTime' => 'A timestamp that tells when the lifecycle configuration was created.
', 'DescribeNotebookInstanceOutput$CreationTime' => 'A timestamp. Use this parameter to return the time when the notebook instance was created
', 'DescribeSpaceResponse$CreationTime' => 'The creation time.
', 'DescribeUserProfileResponse$CreationTime' => 'The creation time.
', 'DomainDetails$CreationTime' => 'The creation time.
', 'FeatureGroup$CreationTime' => 'The time a FeatureGroup was created.
A timestamp indicating when the feature was created.
', 'InferenceRecommendationsJob$CreationTime' => 'A timestamp that shows when the job was created.
', 'ListAlgorithmsInput$CreationTimeAfter' => 'A filter that returns only algorithms created after the specified time (timestamp).
', 'ListAlgorithmsInput$CreationTimeBefore' => 'A filter that returns only algorithms created before the specified time (timestamp).
', 'ListCodeRepositoriesInput$CreationTimeAfter' => 'A filter that returns only Git repositories that were created after the specified time.
', 'ListCodeRepositoriesInput$CreationTimeBefore' => 'A filter that returns only Git repositories that were created before the specified time.
', 'ListCompilationJobsRequest$CreationTimeAfter' => 'A filter that returns the model compilation jobs that were created after a specified time.
', 'ListCompilationJobsRequest$CreationTimeBefore' => 'A filter that returns the model compilation jobs that were created before a specified time.
', 'ListFeatureGroupsRequest$CreationTimeAfter' => '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 date and time.
A filter that returns only jobs created after the specified time (timestamp).
', 'ListInferenceRecommendationsJobsRequest$CreationTimeBefore' => 'A filter that returns only jobs created before the specified time (timestamp).
', 'ListModelPackageGroupsInput$CreationTimeAfter' => 'A filter that returns only model groups created after the specified time.
', 'ListModelPackageGroupsInput$CreationTimeBefore' => 'A filter that returns only model groups created before the specified time.
', 'ListModelPackagesInput$CreationTimeAfter' => 'A filter that returns only model packages created after the specified time (timestamp).
', 'ListModelPackagesInput$CreationTimeBefore' => 'A filter that returns only model packages created before the specified time (timestamp).
', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeBefore' => 'A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeAfter' => 'A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
', 'ListNotebookInstancesInput$CreationTimeBefore' => 'A filter that returns only notebook instances that were created before the specified time (timestamp).
', 'ListNotebookInstancesInput$CreationTimeAfter' => 'A filter that returns only notebook instances that were created after the specified time (timestamp).
', 'ModelPackage$CreationTime' => 'The time that the model package was created.
', 'ModelPackageGroup$CreationTime' => 'The time that the model group was created.
', 'ModelPackageGroupSummary$CreationTime' => 'The time that the model group was created.
', 'ModelPackageSummary$CreationTime' => 'A timestamp that shows when the model package was created.
', 'NotebookInstanceLifecycleConfigSummary$CreationTime' => 'A timestamp that tells when the lifecycle configuration was created.
', 'NotebookInstanceSummary$CreationTime' => 'A timestamp that shows when the notebook instance was created.
', 'SpaceDetails$CreationTime' => 'The creation time.
', 'UserProfileDetails$CreationTime' => 'The creation time.
', ], ], 'CrossAccountFilterOption' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$CrossAccountFilterOption' => ' 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.
The list of all content type headers that SageMaker will treat as CSV and capture accordingly.
', ], ], 'CustomImage' => [ 'base' => 'A custom SageMaker image. For more information, see Bring your own SageMaker image.
', 'refs' => [ 'CustomImages$member' => NULL, ], ], 'CustomImages' => [ 'base' => NULL, 'refs' => [ 'KernelGatewayAppSettings$CustomImages' => 'A list of custom SageMaker images that are configured to run as a KernelGateway app.
', 'RSessionAppSettings$CustomImages' => 'A list of custom SageMaker images that are configured to run as a RSession app.
', ], ], 'CustomerMetadataKey' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataKeyList$member' => NULL, 'CustomerMetadataMap$key' => NULL, ], ], 'CustomerMetadataKeyList' => [ 'base' => NULL, 'refs' => [ 'UpdateModelPackageInput$CustomerMetadataPropertiesToRemove' => 'The metadata properties associated with the model package versions to remove.
', ], ], 'CustomerMetadataMap' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$CustomerMetadataProperties' => 'The metadata properties associated with the model package versions.
', 'DescribeModelPackageOutput$CustomerMetadataProperties' => 'The metadata properties associated with the model package versions.
', 'ModelPackage$CustomerMetadataProperties' => 'The metadata properties for the model package.
', 'UpdateModelPackageInput$CustomerMetadataProperties' => 'The metadata properties associated with the model package versions.
', ], ], 'CustomerMetadataValue' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataMap$value' => NULL, ], ], 'CustomizedMetricSpecification' => [ 'base' => 'A customized metric.
', 'refs' => [ 'MetricSpecification$Customized' => 'Information about a customized metric.
', ], ], 'DataCaptureConfig' => [ 'base' => 'Configuration to control how SageMaker captures inference data.
', 'refs' => [ 'CreateEndpointConfigInput$DataCaptureConfig' => NULL, 'DescribeEndpointConfigOutput$DataCaptureConfig' => NULL, ], ], 'DataCaptureConfigSummary' => [ 'base' => 'The currently active data capture configuration used by your Endpoint.
', 'refs' => [ 'DescribeEndpointOutput$DataCaptureConfig' => NULL, 'Endpoint$DataCaptureConfig' => NULL, ], ], 'DataCatalogConfig' => [ 'base' => 'The meta data of the Glue table which serves as data catalog for the OfflineStore.
The meta data of the Glue table that is autogenerated when an OfflineStore is created.
Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
The URL of the notebook location.
', ], ], 'DataInputConfig' => [ 'base' => NULL, 'refs' => [ 'InputConfig$DataInputConfig' => '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"]}
The input configuration object for the model.
', ], ], 'DataProcessing' => [ 'base' => '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.
', 'refs' => [ 'CreateTransformJobRequest$DataProcessing' => '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.
', 'DescribeTransformJobResponse$DataProcessing' => NULL, 'TransformJob$DataProcessing' => NULL, ], ], 'DataQualityAppSpecification' => [ 'base' => 'Information about the container that a data quality monitoring job runs.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityAppSpecification' => 'Specifies the container that runs the monitoring job.
', 'DescribeDataQualityJobDefinitionResponse$DataQualityAppSpecification' => 'Information about the container that runs the data quality monitoring job.
', ], ], 'DataQualityBaselineConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityBaselineConfig' => 'Configures the constraints and baselines for the monitoring job.
', 'DescribeDataQualityJobDefinitionResponse$DataQualityBaselineConfig' => 'The constraints and baselines for the data quality monitoring job definition.
', ], ], 'DataQualityJobInput' => [ 'base' => 'The input for the data quality monitoring job. Currently endpoints are supported for input.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobInput' => 'A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.
', 'DescribeDataQualityJobDefinitionResponse$DataQualityJobInput' => 'The list of inputs for the data quality monitoring job. Currently endpoints are supported.
', ], ], 'DataSource' => [ 'base' => 'Describes the location of the channel data.
', 'refs' => [ 'Channel$DataSource' => 'The location of the channel data.
', ], ], 'Database' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Database' => 'The name of the Glue table database.
', ], ], 'DatasetDefinition' => [ 'base' => 'Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.
Configuration for a Dataset Definition input.
', ], ], 'DebugHookConfig' => [ 'base' => '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.
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.
Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
', 'DescribeTrainingJobResponse$DebugRuleConfigurations' => 'Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
', 'TrainingJob$DebugRuleConfigurations' => 'Information about the debug rule configuration.
', ], ], 'DebugRuleEvaluationStatus' => [ 'base' => 'Information about the status of the rule evaluation.
', 'refs' => [ 'DebugRuleEvaluationStatuses$member' => NULL, ], ], 'DebugRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$DebugRuleEvaluationStatuses' => 'Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.
', 'TrainingJob$DebugRuleEvaluationStatuses' => 'Information about the evaluation status of the rules for the training job.
', ], ], 'DefaultGid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultGid' => 'The default POSIX group ID (GID). If not specified, defaults to 100.
A collection of settings that apply to spaces created in the Domain.
', 'refs' => [ 'CreateDomainRequest$DefaultSpaceSettings' => 'The default settings used to create a space.
', 'DescribeDomainResponse$DefaultSpaceSettings' => 'The default settings used to create a space.
', 'UpdateDomainRequest$DefaultSpaceSettings' => 'The default settings used to create a space within the Domain.
', ], ], 'DefaultUid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultUid' => 'The default POSIX user ID (UID). If not specified, defaults to 1000.
The hub content dependency copy path.
', ], ], 'DependencyOriginPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyOriginPath' => 'The hub content dependency origin path.
', ], ], 'DeployedImage' => [ 'base' => '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.
An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the 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 deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
', 'refs' => [ 'CreateEndpointInput$DeploymentConfig' => NULL, 'DescribeEndpointOutput$LastDeploymentConfig' => 'The most recent deployment configuration for the endpoint.
', 'UpdateEndpointInput$DeploymentConfig' => 'The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
', ], ], 'DeploymentRecommendation' => [ 'base' => 'A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.
', 'refs' => [ 'DescribeModelOutput$DeploymentRecommendation' => 'A set of recommended deployment configurations for the model.
', 'Model$DeploymentRecommendation' => 'A set of recommended deployment configurations for the model.
', ], ], 'DeploymentStage' => [ 'base' => 'Contains information about a stage in an edge deployment plan.
', 'refs' => [ 'DeploymentStages$member' => NULL, ], ], 'DeploymentStageMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanRequest$MaxResults' => 'The maximum number of results to select (50 by default).
', ], ], 'DeploymentStageStatusSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanResponse$Stages' => 'List of stages in the edge deployment plan.
', ], ], 'DeploymentStageStatusSummary' => [ 'base' => 'Contains information summarizing the deployment stage results.
', 'refs' => [ 'DeploymentStageStatusSummaries$member' => NULL, ], ], 'DeploymentStages' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$Stages' => 'List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
', 'CreateEdgeDeploymentStageRequest$Stages' => 'List of stages to be added to the edge deployment plan.
', ], ], 'DeregisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$Description' => 'A free-form description of a FeatureGroup.
A free form description of the feature group.
', 'FeatureGroup$Description' => 'A free form description of a FeatureGroup.
Specifies weight and capacity values for a production variant.
', 'refs' => [ 'DesiredWeightAndCapacityList$member' => NULL, ], ], 'DesiredWeightAndCapacityList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointWeightsAndCapacitiesInput$DesiredWeightsAndCapacities' => 'An object that provides new capacity and weight values for a variant.
', ], ], 'DestinationS3Uri' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$S3OutputPath' => 'The Amazon S3 location to upload inference responses to.
', 'AsyncInferenceOutputConfig$S3FailurePath' => 'The Amazon S3 location to upload failure inference responses to.
', 'BatchTransformInput$DataCapturedDestinationS3Uri' => 'The Amazon S3 location being used to capture the data.
', 'DataCaptureConfig$DestinationS3Uri' => 'The Amazon S3 location used to capture the data.
', 'DataCaptureConfigSummary$DestinationS3Uri' => 'The Amazon S3 location being used to capture the data.
', 'InferenceExperimentDataStorageConfig$Destination' => 'The Amazon S3 bucket where the inference request and response data is stored.
', 'ProductionVariantCoreDumpConfig$DestinationS3Uri' => 'The Amazon S3 bucket to send the core dump to.
', ], ], 'DetailedAlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$Status' => 'The current status.
', ], ], 'DetailedModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusItem$Status' => 'The current status.
', ], ], 'Device' => [ 'base' => 'Information of a particular device.
', 'refs' => [ 'Devices$member' => NULL, ], ], 'DeviceArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$DeviceArn' => 'The Amazon Resource Name (ARN) of the device.
', 'DeviceDeploymentSummary$DeviceArn' => 'The ARN of the device.
', 'DeviceSummary$DeviceArn' => 'Amazon Resource Name (ARN) of the device.
', ], ], 'DeviceDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'DeviceDeploymentSummary$DeviceDeploymentStatus' => 'The deployment status of the device.
', ], ], 'DeviceDeploymentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStageDevicesResponse$DeviceDeploymentSummaries' => 'List of summaries of devices allocated to the stage.
', ], ], 'DeviceDeploymentSummary' => [ 'base' => 'Contains information summarizing device details and deployment status.
', 'refs' => [ 'DeviceDeploymentSummaries$member' => NULL, ], ], 'DeviceDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Description' => 'A description of the device.
', 'Device$Description' => 'Description of the device.
', 'DeviceDeploymentSummary$Description' => 'The description of the device.
', 'DeviceSummary$Description' => 'A description of the device.
', ], ], 'DeviceFleetArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$DeviceFleetArn' => 'The The Amazon Resource Name (ARN) of the fleet.
', 'DeviceFleetSummary$DeviceFleetArn' => 'Amazon Resource Name (ARN) of the device fleet.
', 'GetDeviceFleetReportResponse$DeviceFleetArn' => 'The Amazon Resource Name (ARN) of the device.
', ], ], 'DeviceFleetDescription' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$Description' => 'A description of the fleet.
', 'DescribeDeviceFleetResponse$Description' => 'A description of the fleet.
', 'GetDeviceFleetReportResponse$Description' => 'Description of the fleet.
', 'UpdateDeviceFleetRequest$Description' => 'Description of the fleet.
', ], ], 'DeviceFleetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsResponse$DeviceFleetSummaries' => 'Summary of the device fleet.
', ], ], 'DeviceFleetSummary' => [ 'base' => 'Summary of the device fleet.
', 'refs' => [ 'DeviceFleetSummaries$member' => NULL, ], ], 'DeviceName' => [ 'base' => NULL, 'refs' => [ 'Device$DeviceName' => 'The name of the device.
', 'DeviceDeploymentSummary$DeviceName' => 'The name of the device.
', 'DeviceNames$member' => NULL, 'DeviceSelectionConfig$DeviceNameContains' => 'A filter to select devices with names containing this name.
', ], ], 'DeviceNames' => [ 'base' => NULL, 'refs' => [ 'DeregisterDevicesRequest$DeviceNames' => 'The unique IDs of the devices.
', 'DeviceSelectionConfig$DeviceNames' => 'List of devices chosen to deploy.
', ], ], 'DeviceSelectionConfig' => [ 'base' => 'Contains information about the configurations of selected devices.
', 'refs' => [ 'DeploymentStage$DeviceSelectionConfig' => 'Configuration of the devices in the stage.
', 'DeploymentStageStatusSummary$DeviceSelectionConfig' => 'Configuration of the devices in the stage.
', ], ], 'DeviceStats' => [ 'base' => 'Status of devices.
', 'refs' => [ 'GetDeviceFleetReportResponse$DeviceStats' => 'Status of devices.
', ], ], 'DeviceSubsetType' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$DeviceSubsetType' => 'Type of device subsets to deploy to the current stage.
', ], ], 'DeviceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDevicesResponse$DeviceSummaries' => 'Summary of devices.
', ], ], 'DeviceSummary' => [ 'base' => 'Summary of the device.
', 'refs' => [ 'DeviceSummaries$member' => NULL, ], ], 'Devices' => [ 'base' => NULL, 'refs' => [ 'RegisterDevicesRequest$Devices' => 'A list of devices to register with SageMaker Edge Manager.
', 'UpdateDevicesRequest$Devices' => 'List of devices to register with Edge Manager agent.
', ], ], 'DirectInternetAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$DirectInternetAccess' => 'Sets whether SageMaker 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 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.
Describes whether SageMaker 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 training and endpoint services.
For more information, see Notebook Instances Are Internet-Enabled by Default.
', ], ], 'Direction' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$Direction' => 'Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
', ], ], 'DirectoryPath' => [ 'base' => NULL, 'refs' => [ 'CheckpointConfig$LocalPath' => '(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.
Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.
Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
The full path to the directory to associate with the channel.
', 'ProfilerRuleConfiguration$LocalPath' => 'Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.
Configuration to turn off Amazon SageMaker Debugger\'s system monitoring and profiling functionality. To turn it off, set to True.
To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.
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.
', ], ], 'DisassociateDefaultCodeRepository' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateDefaultCodeRepository' => '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.
', ], ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAcceleratorTypes' => 'A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.
', ], ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateLifecycleConfig' => '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 document schema version for the hub content.
', 'HubContentInfo$DocumentSchemaVersion' => 'The version of the hub content document schema.
', 'ImportHubContentRequest$DocumentSchemaVersion' => 'The version of the hub content schema to import.
', 'ListHubContentVersionsRequest$MaxSchemaVersion' => 'The upper bound of the hub content schema version.
', 'ListHubContentsRequest$MaxSchemaVersion' => 'The upper bound of the hub content schema verion.
', ], ], 'Dollars' => [ 'base' => NULL, 'refs' => [ 'USD$Dollars' => 'The whole number of dollars in the amount.
', ], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainResponse$DomainArn' => 'The Amazon Resource Name (ARN) of the created domain.
', 'DescribeDomainResponse$DomainArn' => 'The domain\'s Amazon Resource Name (ARN).
', 'DomainDetails$DomainArn' => 'The domain\'s Amazon Resource Name (ARN).
', 'UpdateDomainResponse$DomainArn' => 'The Amazon Resource Name (ARN) of the domain.
', ], ], 'DomainDetails' => [ 'base' => 'The domain\'s details.
', 'refs' => [ 'DomainList$member' => NULL, ], ], 'DomainId' => [ 'base' => NULL, 'refs' => [ 'AppDetails$DomainId' => 'The domain ID.
', 'CreateAppRequest$DomainId' => 'The domain ID.
', 'CreatePresignedDomainUrlRequest$DomainId' => 'The domain ID.
', 'CreateSpaceRequest$DomainId' => 'The ID of the associated Domain.
', 'CreateUserProfileRequest$DomainId' => 'The ID of the associated Domain.
', 'DeleteAppRequest$DomainId' => 'The domain ID.
', 'DeleteDomainRequest$DomainId' => 'The domain ID.
', 'DeleteSpaceRequest$DomainId' => 'The ID of the associated Domain.
', 'DeleteUserProfileRequest$DomainId' => 'The domain ID.
', 'DescribeAppRequest$DomainId' => 'The domain ID.
', 'DescribeAppResponse$DomainId' => 'The domain ID.
', 'DescribeDomainRequest$DomainId' => 'The domain ID.
', 'DescribeDomainResponse$DomainId' => 'The domain ID.
', 'DescribeSpaceRequest$DomainId' => 'The ID of the associated Domain.
', 'DescribeSpaceResponse$DomainId' => 'The ID of the associated Domain.
', 'DescribeUserProfileRequest$DomainId' => 'The domain ID.
', 'DescribeUserProfileResponse$DomainId' => 'The ID of the domain that contains the profile.
', 'DomainDetails$DomainId' => 'The domain ID.
', 'ListAppsRequest$DomainIdEquals' => 'A parameter to search for the domain ID.
', 'ListSpacesRequest$DomainIdEquals' => 'A parameter to search for the Domain ID.
', 'ListUserProfilesRequest$DomainIdEquals' => 'A parameter by which to filter the results.
', 'SpaceDetails$DomainId' => 'The ID of the associated Domain.
', 'UpdateDomainRequest$DomainId' => 'The ID of the domain to be updated.
', 'UpdateSpaceRequest$DomainId' => 'The ID of the associated Domain.
', 'UpdateUserProfileRequest$DomainId' => 'The domain ID.
', 'UserProfileDetails$DomainId' => 'The domain ID.
', ], ], 'DomainList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsResponse$Domains' => 'The list of domains.
', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$DomainName' => 'A name for the domain.
', 'DescribeDomainResponse$DomainName' => 'The domain name.
', 'DomainDetails$DomainName' => 'The domain name.
', ], ], 'DomainSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$SecurityGroupIds' => 'The security groups for the Amazon Virtual Private Cloud that the Domain uses for 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 apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.
A collection of Domain settings.
A collection of Domain settings.
A collection of Domain configuration settings to update.
A collection of DomainSettings configuration values to update.
The status.
', 'DomainDetails$Status' => 'The status.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$TargetValue' => 'The recommended target value to specify for the metric when creating a scaling policy.
', ], ], 'DoubleParameterValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameterValue$NumberValue' => 'The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can\'t specify the StringValue parameter.
Represents the drift check baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'CreateModelPackageInput$DriftCheckBaselines' => '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.
', 'DescribeModelPackageOutput$DriftCheckBaselines' => '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.
', 'ModelPackage$DriftCheckBaselines' => 'Represents the drift check baselines that can be used when the model monitor is set using the model package.
', ], ], 'DriftCheckBias' => [ 'base' => 'Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'DriftCheckBaselines$Bias' => 'Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
', ], ], 'DriftCheckExplainability' => [ 'base' => 'Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'DriftCheckBaselines$Explainability' => 'Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
', ], ], 'DriftCheckModelDataQuality' => [ 'base' => 'Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'DriftCheckBaselines$ModelDataQuality' => 'Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.
', ], ], 'DriftCheckModelQuality' => [ 'base' => 'Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
', 'refs' => [ 'DriftCheckBaselines$ModelQuality' => 'Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
', ], ], 'DynamicScalingConfiguration' => [ 'base' => 'An object with the recommended values for you to specify when creating an autoscaling policy.
', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$DynamicScalingConfiguration' => 'An object with the recommended values for you to specify when creating an autoscaling policy.
', ], ], 'EMRStepMetadata' => [ 'base' => 'The configurations and outcomes of an Amazon EMR step execution.
', 'refs' => [ 'PipelineExecutionStepMetadata$EMR' => 'The configurations and outcomes of an Amazon EMR step execution.
', ], ], 'Edge' => [ 'base' => 'A directed edge connecting two lineage entities.
', 'refs' => [ 'Edges$member' => NULL, ], ], 'EdgeDeploymentConfig' => [ 'base' => 'Contains information about the configuration of a deployment.
', 'refs' => [ 'DeploymentStage$DeploymentConfig' => 'Configuration of the deployment details.
', 'DeploymentStageStatusSummary$DeploymentConfig' => 'Configuration of the deployment details.
', ], ], 'EdgeDeploymentModelConfig' => [ 'base' => 'Contains information about the configuration of a model in a deployment.
', 'refs' => [ 'EdgeDeploymentModelConfigs$member' => NULL, ], ], 'EdgeDeploymentModelConfigs' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$ModelConfigs' => 'List of models associated with the edge deployment plan.
', 'DescribeEdgeDeploymentPlanResponse$ModelConfigs' => 'List of models associated with the edge deployment plan.
', ], ], 'EdgeDeploymentPlanArn' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => 'The ARN of the edge deployment plan.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => 'The ARN of edge deployment plan.
', 'DeviceDeploymentSummary$EdgeDeploymentPlanArn' => 'The ARN of the edge deployment plan.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanArn' => 'The ARN of the edge deployment plan.
', ], ], 'EdgeDeploymentPlanSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansResponse$EdgeDeploymentPlanSummaries' => 'List of summaries of edge deployment plans.
', ], ], 'EdgeDeploymentPlanSummary' => [ 'base' => 'Contains information summarizing an edge deployment plan.
', 'refs' => [ 'EdgeDeploymentPlanSummaries$member' => NULL, ], ], 'EdgeDeploymentStatus' => [ 'base' => 'Contains information summarizing the deployment stage results.
', 'refs' => [ 'DeploymentStageStatusSummary$DeploymentStatus' => 'General status of the current state.
', ], ], 'EdgeModel' => [ 'base' => 'The model on the edge device.
', 'refs' => [ 'EdgeModels$member' => NULL, ], ], 'EdgeModelStat' => [ 'base' => 'Status of edge devices with this model.
', 'refs' => [ 'EdgeModelStats$member' => NULL, ], ], 'EdgeModelStats' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$ModelStats' => 'Status of model on device.
', ], ], 'EdgeModelSummaries' => [ 'base' => NULL, 'refs' => [ 'DeviceSummary$Models' => 'Models on the device.
', ], ], 'EdgeModelSummary' => [ 'base' => 'Summary of model on edge device.
', 'refs' => [ 'EdgeModelSummaries$member' => NULL, ], ], 'EdgeModels' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Models' => 'Models on the device.
', ], ], 'EdgeOutputConfig' => [ 'base' => 'The output configuration.
', 'refs' => [ 'CreateDeviceFleetRequest$OutputConfig' => 'The output configuration for storing sample data collected by the fleet.
', 'CreateEdgePackagingJobRequest$OutputConfig' => 'Provides information about the output location for the packaged model.
', 'DescribeDeviceFleetResponse$OutputConfig' => 'The output configuration for storing sampled data.
', 'DescribeEdgePackagingJobResponse$OutputConfig' => 'The output configuration for the edge packaging job.
', 'GetDeviceFleetReportResponse$OutputConfig' => 'The output configuration for storing sample data collected by the fleet.
', 'UpdateDeviceFleetRequest$OutputConfig' => 'Output configuration for storing sample data collected by the fleet.
', ], ], 'EdgePackagingJobArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobArn' => 'The Amazon Resource Name (ARN) of the edge packaging job.
', 'EdgePackagingJobSummary$EdgePackagingJobArn' => 'The Amazon Resource Name (ARN) of the edge packaging job.
', ], ], 'EdgePackagingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatus' => 'The current status of the packaging job.
', 'EdgePackagingJobSummary$EdgePackagingJobStatus' => 'The status of the edge packaging job.
', 'ListEdgePackagingJobsRequest$StatusEquals' => 'The job status to filter for.
', ], ], 'EdgePackagingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsResponse$EdgePackagingJobSummaries' => 'Summaries of edge packaging jobs.
', ], ], 'EdgePackagingJobSummary' => [ 'base' => 'Summary of edge packaging job.
', 'refs' => [ 'EdgePackagingJobSummaries$member' => NULL, ], ], 'EdgePresetDeploymentArtifact' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Artifact' => 'The Amazon Resource Name (ARN) of the generated deployable resource.
', ], ], 'EdgePresetDeploymentOutput' => [ 'base' => 'The output of a SageMaker Edge Manager deployable resource.
', 'refs' => [ 'DescribeEdgePackagingJobResponse$PresetDeploymentOutput' => 'The output of a SageMaker Edge Manager deployable resource.
', ], ], 'EdgePresetDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Status' => 'The status of the deployable resource.
', ], ], 'EdgePresetDeploymentType' => [ 'base' => NULL, 'refs' => [ 'EdgeOutputConfig$PresetDeploymentType' => 'The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
', 'EdgePresetDeploymentOutput$Type' => 'The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
', ], ], 'EdgeVersion' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$Version' => 'Version of the agent.
', 'CreateEdgePackagingJobRequest$ModelVersion' => 'The version of the model.
', 'DescribeDeviceResponse$AgentVersion' => 'Edge Manager agent version.
', 'DescribeEdgePackagingJobResponse$ModelVersion' => 'The version of the model.
', 'DeviceSummary$AgentVersion' => 'Edge Manager agent version.
', 'EdgeModel$ModelVersion' => 'The model version.
', 'EdgeModelStat$ModelVersion' => 'The model version.
', 'EdgeModelSummary$ModelVersion' => 'The version model.
', 'EdgePackagingJobSummary$ModelVersion' => 'The version of the model.
', ], ], 'Edges' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Edges' => 'A list of edges that connect vertices in the response.
', ], ], 'EfsUid' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$HomeEfsFileSystemUid' => 'The ID of the space\'s profile in the Amazon Elastic File System volume.
', 'DescribeUserProfileResponse$HomeEfsFileSystemUid' => 'The ID of the user\'s profile in the Amazon Elastic File System (EFS) volume.
', ], ], 'EnableCapture' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$EnableCapture' => 'Whether data capture should be enabled or disabled (defaults to enabled).
', 'DataCaptureConfigSummary$EnableCapture' => 'Whether data capture is enabled or disabled.
', ], ], 'EnableIotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$EnableIotRoleAlias' => '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".
', 'UpdateDeviceFleetRequest$EnableIotRoleAlias' => '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".
', ], ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'Endpoint' => [ 'base' => 'A hosted endpoint for real-time inference.
', 'refs' => [ 'SearchRecord$Endpoint' => NULL, ], ], 'EndpointArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointOutput$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'DescribeEndpointOutput$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'Endpoint$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'EndpointSummary$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'ModelDashboardEndpoint$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'UpdateEndpointOutput$EndpointArn' => 'The Amazon Resource Name (ARN) of the endpoint.
', 'UpdateEndpointWeightsAndCapacitiesOutput$EndpointArn' => 'The Amazon Resource Name (ARN) of the updated endpoint.
', ], ], 'EndpointConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigOutput$EndpointConfigArn' => 'The Amazon Resource Name (ARN) of the endpoint configuration.
', 'DescribeEndpointConfigOutput$EndpointConfigArn' => 'The Amazon Resource Name (ARN) of the endpoint configuration.
', 'EndpointConfigSummary$EndpointConfigArn' => 'The Amazon Resource Name (ARN) of the endpoint configuration.
', ], ], 'EndpointConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$EndpointConfigName' => 'The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
', 'CreateEndpointInput$EndpointConfigName' => 'The name of an endpoint configuration. For more information, see CreateEndpointConfig.
', 'DeleteEndpointConfigInput$EndpointConfigName' => 'The name of the endpoint configuration that you want to delete.
', 'DescribeEndpointConfigInput$EndpointConfigName' => 'The name of the endpoint configuration.
', 'DescribeEndpointConfigOutput$EndpointConfigName' => 'Name of the SageMaker endpoint configuration.
', 'DescribeEndpointOutput$EndpointConfigName' => 'The name of the endpoint configuration associated with this endpoint.
', 'Endpoint$EndpointConfigName' => 'The endpoint configuration associated with the endpoint.
', 'EndpointConfigSummary$EndpointConfigName' => 'The name of the endpoint configuration.
', 'EndpointMetadata$EndpointConfigName' => 'The name of the endpoint configuration.
', 'PendingDeploymentSummary$EndpointConfigName' => 'The name of the endpoint configuration used in the deployment.
', 'UpdateEndpointInput$EndpointConfigName' => 'The name of the new endpoint configuration.
', ], ], 'EndpointConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NameContains' => 'A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.
', ], ], 'EndpointConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortBy' => 'The field to sort results by. The default is CreationTime.
Provides summary information for an endpoint configuration.
', 'refs' => [ 'EndpointConfigSummaryList$member' => NULL, ], ], 'EndpointConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsOutput$EndpointConfigs' => 'An array of endpoint configurations.
', ], ], 'EndpointInfo' => [ 'base' => 'Details about a customer endpoint that was compared in an Inference Recommender job.
', 'refs' => [ 'EndpointPerformance$EndpointInfo' => NULL, 'Endpoints$member' => NULL, ], ], 'EndpointInput' => [ 'base' => 'Input object for the endpoint
', 'refs' => [ 'DataQualityJobInput$EndpointInput' => NULL, 'ModelBiasJobInput$EndpointInput' => NULL, 'ModelExplainabilityJobInput$EndpointInput' => NULL, 'ModelQualityJobInput$EndpointInput' => NULL, 'MonitoringInput$EndpointInput' => 'The endpoint for a monitoring job.
', ], ], 'EndpointInputConfiguration' => [ 'base' => 'The endpoint configuration for the load test.
', 'refs' => [ 'EndpointInputConfigurations$member' => NULL, ], ], 'EndpointInputConfigurations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$EndpointConfigurations' => 'Specifies the endpoint configuration to use for a job.
', ], ], 'EndpointMetadata' => [ 'base' => 'The metadata of the endpoint.
', 'refs' => [ 'DescribeInferenceExperimentResponse$EndpointMetadata' => 'The metadata of the endpoint on which the inference experiment ran.
', ], ], 'EndpointName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointInput$EndpointName' => '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.
The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.
', 'DeleteEndpointInput$EndpointName' => 'The name of the endpoint that you want to delete.
', 'DescribeEndpointInput$EndpointName' => 'The name of the endpoint.
', 'DescribeEndpointOutput$EndpointName' => 'Name of the endpoint.
', 'DescribeMonitoringScheduleResponse$EndpointName' => 'The name of the endpoint for the monitoring job.
', 'Endpoint$EndpointName' => 'The name of the endpoint.
', 'EndpointInfo$EndpointName' => 'The name of a customer\'s endpoint.
', 'EndpointInput$EndpointName' => 'An endpoint in customer\'s account which has enabled DataCaptureConfig enabled.
The name of the endpoint.
', 'EndpointSummary$EndpointName' => 'The name of the endpoint.
', 'GetScalingConfigurationRecommendationRequest$EndpointName' => '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.
The name of an endpoint benchmarked during a previously completed Inference Recommender job.
', 'ListDataQualityJobDefinitionsRequest$EndpointName' => 'A filter that lists the data quality job definitions associated with the specified endpoint.
', 'ListModelBiasJobDefinitionsRequest$EndpointName' => 'Name of the endpoint to monitor for model bias.
', 'ListModelExplainabilityJobDefinitionsRequest$EndpointName' => 'Name of the endpoint to monitor for model explainability.
', 'ListModelQualityJobDefinitionsRequest$EndpointName' => 'A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.
', 'ListMonitoringExecutionsRequest$EndpointName' => 'Name of a specific endpoint to fetch jobs for.
', 'ListMonitoringSchedulesRequest$EndpointName' => 'Name of a specific endpoint to fetch schedules for.
', 'ModelDashboardEndpoint$EndpointName' => 'The endpoint name.
', 'ModelDashboardMonitoringSchedule$EndpointName' => 'The endpoint which is monitored.
', 'ModelDeployConfig$EndpointName' => '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.
The name of the endpoint to which the model has been deployed.
If model deployment fails, this field is omitted from the response.
The name of the endpoint used to run the monitoring job.
', 'MonitoringJobDefinitionSummary$EndpointName' => 'The name of the endpoint that the job monitors.
', 'MonitoringSchedule$EndpointName' => 'The endpoint that hosts the model being monitored.
', 'MonitoringScheduleSummary$EndpointName' => 'The name of the endpoint using the monitoring schedule.
', 'UpdateEndpointInput$EndpointName' => 'The name of the endpoint whose configuration you want to update.
', 'UpdateEndpointWeightsAndCapacitiesInput$EndpointName' => 'The name of an existing SageMaker endpoint.
', ], ], 'EndpointNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$NameContains' => 'A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
', ], ], 'EndpointOutputConfiguration' => [ 'base' => 'The endpoint configuration made by Inference Recommender during a recommendation job.
', 'refs' => [ 'InferenceRecommendation$EndpointConfiguration' => 'Defines the endpoint configuration parameters.
', 'RecommendationJobInferenceBenchmark$EndpointConfiguration' => NULL, ], ], 'EndpointPerformance' => [ 'base' => 'The performance results from running an Inference Recommender job on an existing endpoint.
', 'refs' => [ 'EndpointPerformances$member' => NULL, ], ], 'EndpointPerformances' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$EndpointPerformances' => 'The performance results from running an Inference Recommender job on an existing endpoint.
', ], ], 'EndpointSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$SortBy' => 'Sorts the list of results. The default is CreationTime.
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.
The status of the endpoint.
', 'EndpointMetadata$EndpointStatus' => 'The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.
', 'EndpointSummary$EndpointStatus' => '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.
A filter that returns only endpoints with the specified status.
', 'ModelDashboardEndpoint$EndpointStatus' => 'The endpoint status.
', ], ], 'EndpointSummary' => [ 'base' => 'Provides summary information for an endpoint.
', 'refs' => [ 'EndpointSummaryList$member' => NULL, ], ], 'EndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsOutput$Endpoints' => 'An array or endpoint objects.
', ], ], 'Endpoints' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$Endpoints' => 'Existing customer endpoints on which to run an Inference Recommender job.
', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Description' => 'A description of the additional Inference specification
', 'AlgorithmSummary$AlgorithmDescription' => 'A brief description of the algorithm.
', 'BatchDescribeModelPackageSummary$ModelPackageDescription' => 'The description of the model package.
', 'ChannelSpecification$Description' => 'A brief description of the channel.
', 'CreateAlgorithmInput$AlgorithmDescription' => 'A description of the algorithm.
', 'CreateModelPackageGroupInput$ModelPackageGroupDescription' => 'A description for the model group.
', 'CreateModelPackageInput$ModelPackageDescription' => 'A description of the model package.
', 'CreateProjectInput$ProjectDescription' => 'A description for the project.
', 'DescribeAlgorithmOutput$AlgorithmDescription' => 'A brief summary about the algorithm.
', 'DescribeModelPackageGroupOutput$ModelPackageGroupDescription' => 'A description of the model group.
', 'DescribeModelPackageOutput$ModelPackageDescription' => 'A brief summary of the model package.
', 'DescribeProjectOutput$ProjectDescription' => 'The description of the project.
', 'HyperParameterSpecification$Description' => 'A brief description of the hyperparameter.
', 'ModelPackage$ModelPackageDescription' => 'The description of the model package.
', 'ModelPackageGroup$ModelPackageGroupDescription' => 'The description for the model group.
', 'ModelPackageGroupSummary$ModelPackageGroupDescription' => 'A description of the model group.
', 'ModelPackageSummary$ModelPackageDescription' => 'A brief description of the model package.
', 'Project$ProjectDescription' => 'The description of the project.
', 'ProjectSummary$ProjectDescription' => 'The description of the project.
', 'UpdateProjectInput$ProjectDescription' => 'The description for the project.
', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Name' => '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.
', 'AlgorithmStatusItem$Name' => 'The name of the algorithm for which the overall status is being reported.
', 'AlgorithmSummary$AlgorithmName' => 'The name of the algorithm that is described by the summary.
', 'AlgorithmValidationProfile$ProfileName' => '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).
', 'BatchDescribeModelPackageSummary$ModelPackageGroupName' => 'The group name for the model package
', 'CodeRepositorySummary$CodeRepositoryName' => 'The name of the Git repository.
', 'CompilationJobSummary$CompilationJobName' => 'The name of the model compilation job that you want a summary for.
', 'CreateAlgorithmInput$AlgorithmName' => 'The name of the algorithm.
', 'CreateCodeRepositoryInput$CodeRepositoryName' => '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).
', 'CreateCompilationJobRequest$CompilationJobName' => 'A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
', 'CreateDeviceFleetRequest$DeviceFleetName' => 'The name of the fleet that the device belongs to.
', 'CreateEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'CreateEdgeDeploymentPlanRequest$DeviceFleetName' => 'The device fleet used for this edge deployment plan.
', 'CreateEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'CreateEdgePackagingJobRequest$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'CreateEdgePackagingJobRequest$CompilationJobName' => 'The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
', 'CreateEdgePackagingJobRequest$ModelName' => 'The name of the model.
', 'CreateModelCardExportJobRequest$ModelCardName' => 'The name of the model card to export.
', 'CreateModelCardExportJobRequest$ModelCardExportJobName' => 'The name of the model card export job.
', 'CreateModelCardRequest$ModelCardName' => 'The unique name of the model card.
', 'CreateModelPackageGroupInput$ModelPackageGroupName' => 'The name of the model group.
', 'CreateModelPackageInput$ModelPackageName' => '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.
', 'DeleteAlgorithmInput$AlgorithmName' => 'The name of the algorithm to delete.
', 'DeleteCodeRepositoryInput$CodeRepositoryName' => 'The name of the Git repository to delete.
', 'DeleteDeviceFleetRequest$DeviceFleetName' => 'The name of the fleet to delete.
', 'DeleteEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan to delete.
', 'DeleteEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan from which the stage will be deleted.
', 'DeleteEdgeDeploymentStageRequest$StageName' => 'The name of the stage.
', 'DeleteModelCardRequest$ModelCardName' => 'The name of the model card to delete.
', 'DeleteModelPackageGroupPolicyInput$ModelPackageGroupName' => 'The name of the model group for which to delete the policy.
', 'DeploymentStage$StageName' => 'The name of the stage.
', 'DeploymentStageStatusSummary$StageName' => 'The name of the stage.
', 'DeregisterDevicesRequest$DeviceFleetName' => 'The name of the fleet the devices belong to.
', 'DescribeAlgorithmOutput$AlgorithmName' => 'The name of the algorithm being described.
', 'DescribeCodeRepositoryInput$CodeRepositoryName' => 'The name of the Git repository to describe.
', 'DescribeCodeRepositoryOutput$CodeRepositoryName' => 'The name of the Git repository.
', 'DescribeCompilationJobRequest$CompilationJobName' => 'The name of the model compilation job that you want information about.
', 'DescribeCompilationJobResponse$CompilationJobName' => 'The name of the model compilation job.
', 'DescribeDeviceFleetRequest$DeviceFleetName' => 'The name of the fleet.
', 'DescribeDeviceFleetResponse$DeviceFleetName' => 'The name of the fleet.
', 'DescribeDeviceRequest$DeviceName' => 'The unique ID of the device.
', 'DescribeDeviceRequest$DeviceFleetName' => 'The name of the fleet the devices belong to.
', 'DescribeDeviceResponse$DeviceName' => 'The unique identifier of the device.
', 'DescribeDeviceResponse$DeviceFleetName' => 'The name of the fleet the device belongs to.
', 'DescribeEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => 'The name of the deployment plan to describe.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'DescribeEdgeDeploymentPlanResponse$DeviceFleetName' => 'The device fleet used for this edge deployment plan.
', 'DescribeEdgePackagingJobRequest$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'DescribeEdgePackagingJobResponse$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'DescribeEdgePackagingJobResponse$CompilationJobName' => 'The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.
', 'DescribeEdgePackagingJobResponse$ModelName' => 'The name of the model.
', 'DescribeModelCardExportJobResponse$ModelCardExportJobName' => 'The name of the model card export job to describe.
', 'DescribeModelCardExportJobResponse$ModelCardName' => 'The name of the model card that the model export job exports.
', 'DescribeModelCardRequest$ModelCardName' => 'The name of the model card to describe.
', 'DescribeModelCardResponse$ModelCardName' => 'The name of the model card.
', 'DescribeModelPackageGroupOutput$ModelPackageGroupName' => 'The name of the model group.
', 'DescribeModelPackageOutput$ModelPackageName' => 'The name of the model package being described.
', 'DescribeModelPackageOutput$ModelPackageGroupName' => 'If the model is a versioned model, the name of the model group that the versioned model belongs to.
', 'DeviceDeploymentSummary$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'DeviceDeploymentSummary$StageName' => 'The name of the stage in the edge deployment plan.
', 'DeviceDeploymentSummary$DeployedStageName' => 'The name of the deployed stage.
', 'DeviceDeploymentSummary$DeviceFleetName' => 'The name of the fleet to which the device belongs to.
', 'DeviceFleetSummary$DeviceFleetName' => 'Name of the device fleet.
', 'DeviceSummary$DeviceName' => 'The unique identifier of the device.
', 'DeviceSummary$DeviceFleetName' => 'The name of the fleet the device belongs to.
', 'EdgeDeploymentModelConfig$ModelHandle' => 'The name the device application uses to reference this model.
', 'EdgeDeploymentModelConfig$EdgePackagingJobName' => 'The edge packaging job associated with this deployment.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'EdgeDeploymentPlanSummary$DeviceFleetName' => 'The name of the device fleet used for the deployment.
', 'EdgeModel$ModelName' => 'The name of the model.
', 'EdgeModelStat$ModelName' => 'The name of the model.
', 'EdgeModelSummary$ModelName' => 'The name of the model.
', 'EdgePackagingJobSummary$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'EdgePackagingJobSummary$CompilationJobName' => 'The name of the SageMaker Neo compilation job.
', 'EdgePackagingJobSummary$ModelName' => 'The name of the model.
', 'GetDeviceFleetReportRequest$DeviceFleetName' => 'The name of the fleet.
', 'GetDeviceFleetReportResponse$DeviceFleetName' => 'The name of the fleet.
', 'GetModelPackageGroupPolicyInput$ModelPackageGroupName' => 'The name of the model group for which to get the resource policy.
', 'ListDevicesRequest$ModelName' => 'A filter that searches devices that contains this name in any of their models.
', 'ListDevicesRequest$DeviceFleetName' => 'Filter for fleets containing this name in their device fleet name.
', 'ListModelCardExportJobsRequest$ModelCardName' => 'List export jobs for the model card with the specified name.
', 'ListModelCardExportJobsRequest$ModelCardExportJobNameContains' => 'Only list model card export jobs with names that contain the specified string.
', 'ListModelCardVersionsRequest$ModelCardName' => 'List model card versions for the model card with the specified name.
', 'ListModelCardsRequest$NameContains' => 'Only list model cards with names that contain the specified string.
', 'ListStageDevicesRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan.
', 'ListStageDevicesRequest$StageName' => 'The name of the stage in the deployment.
', 'ModelCard$ModelCardName' => 'The unique name of the model card.
', 'ModelCardExportJobSummary$ModelCardExportJobName' => 'The name of the model card export job.
', 'ModelCardExportJobSummary$ModelCardName' => 'The name of the model card that the export job exports.
', 'ModelCardSummary$ModelCardName' => 'The name of the model card.
', 'ModelCardVersionSummary$ModelCardName' => 'The name of the model card.
', 'ModelDashboardModelCard$ModelCardName' => 'The name of a model card.
', 'ModelPackage$ModelPackageName' => 'The name of the model.
', 'ModelPackage$ModelPackageGroupName' => 'The model group to which the model belongs.
', 'ModelPackageGroup$ModelPackageGroupName' => 'The name of the model group.
', 'ModelPackageGroupSummary$ModelPackageGroupName' => 'The name of the model group.
', 'ModelPackageStatusItem$Name' => 'The name of the model package for which the overall status is being reported.
', 'ModelPackageSummary$ModelPackageName' => 'The name of the model package.
', 'ModelPackageSummary$ModelPackageGroupName' => 'If the model package is a versioned model, the model group that the versioned model belongs to.
', 'ModelPackageValidationProfile$ProfileName' => 'The name of the profile for the model package.
', 'PutModelPackageGroupPolicyInput$ModelPackageGroupName' => 'The name of the model group to add a resource policy to.
', 'RegisterDevicesRequest$DeviceFleetName' => 'The name of the fleet.
', 'StartEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan to start.
', 'StartEdgeDeploymentStageRequest$StageName' => 'The name of the stage to start.
', 'StopCompilationJobRequest$CompilationJobName' => 'The name of the model compilation job to stop.
', 'StopEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => 'The name of the edge deployment plan to stop.
', 'StopEdgeDeploymentStageRequest$StageName' => 'The name of the stage to stop.
', 'StopEdgePackagingJobRequest$EdgePackagingJobName' => 'The name of the edge packaging job.
', 'UpdateCodeRepositoryInput$CodeRepositoryName' => 'The name of the Git repository to update.
', 'UpdateDeviceFleetRequest$DeviceFleetName' => 'The name of the fleet.
', 'UpdateDevicesRequest$DeviceFleetName' => 'The name of the fleet the devices belong to.
', 'UpdateModelCardRequest$ModelCardName' => 'The name of the model card to update.
', ], ], 'EnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$key' => NULL, ], ], 'EnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Environment' => 'The environment variables to set in the container. For more information, see ContainerDefinition.
', 'ContainerDefinition$Environment' => '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 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 recommended environment variables to set in the model container for Real-Time Inference.
', ], ], 'EnvironmentParameter' => [ 'base' => 'A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.
', 'refs' => [ 'EnvironmentParameters$member' => NULL, ], ], 'EnvironmentParameterRanges' => [ 'base' => 'Specifies the range of environment parameters
', 'refs' => [ 'EndpointInputConfiguration$EnvironmentParameterRanges' => 'The parameter you want to benchmark against.
', ], ], 'EnvironmentParameters' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$EnvironmentParameters' => 'Defines the environment parameters that includes key, value types, and values.
', ], ], 'EnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$value' => NULL, ], ], 'ExecutionRoleIdentityConfig' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$ExecutionRoleIdentityConfig' => 'The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
', 'DomainSettingsForUpdate$ExecutionRoleIdentityConfig' => 'The configuration for attaching a SageMaker 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.
A filter that retrieves only jobs with a specific status.
', 'MonitoringExecutionSummary$MonitoringExecutionStatus' => 'The status of the monitoring job.
', ], ], 'ExitMessage' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ExitMessage' => 'An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
', 'ProcessingJob$ExitMessage' => 'A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
', 'ProcessingJobSummary$ExitMessage' => 'An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
', ], ], 'Experiment' => [ 'base' => 'The properties of an experiment as returned by the Search API.
', 'refs' => [ 'SearchRecord$Experiment' => 'The properties of an experiment.
', ], ], 'ExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateExperimentResponse$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', 'DeleteExperimentResponse$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment that is being deleted.
', 'DescribeExperimentResponse$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', 'Experiment$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', 'ExperimentSummary$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', 'UpdateExperimentResponse$ExperimentArn' => 'The Amazon Resource Name (ARN) of the experiment.
', ], ], 'ExperimentConfig' => [ 'base' => 'Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
', 'refs' => [ 'CreateProcessingJobRequest$ExperimentConfig' => NULL, 'CreateTrainingJobRequest$ExperimentConfig' => NULL, 'CreateTransformJobRequest$ExperimentConfig' => NULL, 'DescribeProcessingJobResponse$ExperimentConfig' => 'The configuration information used to create an experiment.
', 'DescribeTrainingJobResponse$ExperimentConfig' => NULL, 'DescribeTransformJobResponse$ExperimentConfig' => NULL, 'ProcessingJob$ExperimentConfig' => NULL, 'TrainingJob$ExperimentConfig' => NULL, 'TransformJob$ExperimentConfig' => NULL, ], ], 'ExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Description' => 'The description of the action.
', 'CreateContextRequest$Description' => 'The description of the context.
', 'CreateExperimentRequest$Description' => 'The description of the experiment.
', 'DescribeActionResponse$Description' => 'The description of the action.
', 'DescribeContextResponse$Description' => 'The description of the context.
', 'DescribeExperimentResponse$Description' => 'The description of the experiment.
', 'DescribeLineageGroupResponse$Description' => 'The description of the lineage group.
', 'Experiment$Description' => 'The description of the experiment.
', 'UpdateActionRequest$Description' => 'The new description for the action.
', 'UpdateContextRequest$Description' => 'The new description for the context.
', 'UpdateExperimentRequest$Description' => 'The description of the experiment.
', ], ], 'ExperimentEntityName' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionName' => 'The name of the action.
', 'ArtifactSummary$ArtifactName' => 'The name of the artifact.
', 'AssociateTrialComponentRequest$TrialComponentName' => 'The name of the component to associated with the trial.
', 'AssociateTrialComponentRequest$TrialName' => 'The name of the trial to associate with.
', 'AssociationSummary$SourceName' => 'The name of the source.
', 'AssociationSummary$DestinationName' => 'The name of the destination.
', 'ContextSummary$ContextName' => 'The name of the context.
', 'CreateActionRequest$ActionName' => 'The name of the action. Must be unique to your account in an Amazon Web Services Region.
', 'CreateArtifactRequest$ArtifactName' => 'The name of the artifact. Must be unique to your account in an Amazon Web Services Region.
', 'CreateContextRequest$ContextName' => 'The name of the context. Must be unique to your account in an Amazon Web Services Region.
', 'CreateExperimentRequest$ExperimentName' => 'The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.
', 'CreateExperimentRequest$DisplayName' => '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.
The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
', 'CreateTrialComponentRequest$DisplayName' => '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. The name must be unique in your Amazon Web Services account and is not case-sensitive.
', 'CreateTrialRequest$DisplayName' => 'The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.
The name of the experiment to associate the trial with.
', 'DeleteActionRequest$ActionName' => 'The name of the action to delete.
', 'DeleteContextRequest$ContextName' => 'The name of the context to delete.
', 'DeleteExperimentRequest$ExperimentName' => 'The name of the experiment to delete.
', 'DeleteTrialComponentRequest$TrialComponentName' => 'The name of the component to delete.
', 'DeleteTrialRequest$TrialName' => 'The name of the trial to delete.
', 'DescribeActionRequest$ActionName' => 'The name of the action to describe.
', 'DescribeContextResponse$ContextName' => 'The name of the context.
', 'DescribeExperimentRequest$ExperimentName' => 'The name of the experiment to describe.
', 'DescribeExperimentResponse$ExperimentName' => 'The name of the experiment.
', 'DescribeExperimentResponse$DisplayName' => 'The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.
The name of the lineage group.
', 'DescribeLineageGroupResponse$LineageGroupName' => 'The name of the lineage group.
', 'DescribeLineageGroupResponse$DisplayName' => 'The display name of the lineage group.
', 'DescribeTrialComponentResponse$TrialComponentName' => 'The name of the trial component.
', 'DescribeTrialComponentResponse$DisplayName' => 'The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.
The name of the trial to describe.
', 'DescribeTrialResponse$TrialName' => 'The name of the trial.
', 'DescribeTrialResponse$DisplayName' => 'The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.
The name of the experiment the trial is part of.
', 'DisassociateTrialComponentRequest$TrialComponentName' => 'The name of the component to disassociate from the trial.
', 'DisassociateTrialComponentRequest$TrialName' => 'The name of the trial to disassociate from.
', 'Experiment$ExperimentName' => 'The name of the experiment.
', 'Experiment$DisplayName' => 'The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.
The name of an existing experiment to associate with the trial component.
', 'ExperimentConfig$TrialName' => 'The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
', 'ExperimentConfig$TrialComponentDisplayName' => 'The display name for the trial component. If this key isn\'t specified, the display name is the trial component name.
', 'ExperimentConfig$RunName' => 'The name of the experiment run to associate with the trial component.
', 'ExperimentSummary$ExperimentName' => 'The name of the experiment.
', 'ExperimentSummary$DisplayName' => 'The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.
The name or Amazon Resource Name (ARN) of the lineage group.
', 'LineageGroupSummary$DisplayName' => 'The display name of the lineage group summary.
', 'ListTrialComponentsRequest$ExperimentName' => '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 TrialName, you can\'t filter by ExperimentName or SourceArn.
A filter that returns only trials that are part of the specified experiment.
', 'ListTrialsRequest$TrialComponentName' => 'A filter that returns only trials that are associated with the specified trial component.
', 'Parent$TrialName' => 'The name of the trial.
', 'Parent$ExperimentName' => 'The name of the experiment.
', 'PipelineExperimentConfig$ExperimentName' => 'The name of the experiment.
', 'PipelineExperimentConfig$TrialName' => 'The name of the trial.
', 'Trial$TrialName' => 'The name of the trial.
', 'Trial$DisplayName' => 'The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.
The name of the experiment the trial is part of.
', 'TrialComponent$TrialComponentName' => 'The name of the trial component.
', 'TrialComponent$DisplayName' => 'The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.
The name of the experiment run.
', 'TrialComponentSimpleSummary$TrialComponentName' => 'The name of the trial component.
', 'TrialComponentSummary$TrialComponentName' => 'The name of the trial component.
', 'TrialComponentSummary$DisplayName' => 'The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.
The name of the trial.
', 'TrialSummary$DisplayName' => 'The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.
The name of the action to update.
', 'UpdateArtifactRequest$ArtifactName' => 'The new name for the artifact.
', 'UpdateContextRequest$ContextName' => 'The name of the context to update.
', 'UpdateExperimentRequest$ExperimentName' => 'The name of the experiment to update.
', 'UpdateExperimentRequest$DisplayName' => 'The name of the experiment as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, ExperimentName is displayed.
The name of the component to update.
', 'UpdateTrialComponentRequest$DisplayName' => '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 to update.
', 'UpdateTrialRequest$DisplayName' => 'The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.
The name of the action.
', 'DescribeArtifactResponse$ArtifactName' => 'The name of the artifact.
', 'DescribeContextRequest$ContextName' => 'The name of the context to describe.
', 'DescribeTrialComponentRequest$TrialComponentName' => 'The name of the trial component to describe.
', ], ], 'ExperimentSource' => [ 'base' => 'The source of the experiment.
', 'refs' => [ 'DescribeExperimentResponse$Source' => 'The Amazon Resource Name (ARN) of the source and, optionally, the type.
', 'Experiment$Source' => NULL, 'ExperimentSummary$ExperimentSource' => NULL, ], ], 'ExperimentSourceArn' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceArn' => 'The Amazon Resource Name (ARN) of the source.
', ], ], 'ExperimentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsResponse$ExperimentSummaries' => 'A list of the summaries of your experiments.
', ], ], 'ExperimentSummary' => [ 'base' => 'A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.
The number of seconds until the pre-signed URL expires. This value defaults to 300.
', ], ], 'Explainability' => [ 'base' => 'Contains explainability metrics for a model.
', 'refs' => [ 'ModelMetrics$Explainability' => 'Metrics that help explain a model.
', ], ], 'ExplainabilityLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$Explainability' => 'The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.
', ], ], 'ExplainerConfig' => [ 'base' => 'A parameter to activate explainers.
', 'refs' => [ 'CreateEndpointConfigInput$ExplainerConfig' => 'A member of CreateEndpointConfig that enables explainers.
The configuration parameters for an explainer.
', 'DescribeEndpointOutput$ExplainerConfig' => 'The configuration parameters for an explainer.
', ], ], 'FailStepMetadata' => [ 'base' => 'The container for the metadata for Fail step.
', 'refs' => [ 'PipelineExecutionStepMetadata$Fail' => 'The configurations and outcomes of a Fail step execution.
', ], ], 'FailureHandlingPolicy' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentConfig$FailureHandlingPolicy' => '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.
', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Message' => NULL, 'DescribeAppResponse$FailureReason' => 'The failure reason.
', 'DescribeCompilationJobResponse$FailureReason' => 'If a model compilation job failed, the reason it failed.
', 'DescribeDomainResponse$FailureReason' => 'The failure reason.
', 'DescribeEndpointOutput$FailureReason' => 'If the status of the endpoint is Failed, the reason why it failed.
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.
The reason your flow definition failed.
', 'DescribeHubContentResponse$FailureReason' => 'The failure reason if importing hub content failed.
', 'DescribeHubResponse$FailureReason' => 'The failure reason if importing hub content failed.
', 'DescribeHyperParameterTuningJobResponse$FailureReason' => 'If the tuning job failed, the reason it failed.
', 'DescribeImageResponse$FailureReason' => 'When a create, update, or delete operation fails, the reason for the failure.
', 'DescribeImageVersionResponse$FailureReason' => 'When a create or delete operation fails, the reason for the failure.
', 'DescribeInferenceRecommendationsJobResponse$FailureReason' => 'If the job fails, provides information why the job failed.
', 'DescribeLabelingJobResponse$FailureReason' => 'If the job failed, the reason that it failed.
', 'DescribeModelCardExportJobResponse$FailureReason' => 'The failure reason if the model export job fails.
', 'DescribeMonitoringScheduleResponse$FailureReason' => 'A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.
', 'DescribeNotebookInstanceOutput$FailureReason' => 'If status is Failed, the reason it failed.
A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
', 'DescribeSpaceResponse$FailureReason' => 'The failure reason.
', 'DescribeTrainingJobResponse$FailureReason' => 'If the training job failed, the reason it failed.
', 'DescribeTransformJobResponse$FailureReason' => '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 failure reason.
', 'Endpoint$FailureReason' => 'If the endpoint failed, the reason it failed.
', 'EndpointMetadata$FailureReason' => ' 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 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.
The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
The reason that the training job failed.
', 'HyperParameterTuningJobSearchEntity$FailureReason' => 'The error that was created when a hyperparameter tuning job failed.
', 'Image$FailureReason' => 'When a create, update, or delete operation fails, the reason for the failure.
', 'ImageVersion$FailureReason' => 'When a create or delete operation fails, the reason for the failure.
', 'InferenceRecommendationsJob$FailureReason' => 'If the job fails, provides information why the job failed.
', 'LabelingJobSummary$FailureReason' => 'If the LabelingJobStatus field is Failed, this field contains a description of the error.
If the update wasn\'t successful, indicates the reason why it failed.
', 'ModelDashboardMonitoringSchedule$FailureReason' => 'If a monitoring job failed, provides the reason.
', 'MonitoringExecutionSummary$FailureReason' => 'Contains the reason a monitoring job failed, if it failed.
', 'MonitoringSchedule$FailureReason' => 'If the monitoring schedule failed, the reason it failed.
', 'PipelineExecutionStep$FailureReason' => 'The reason why the step failed execution. This is only returned if the step failed its execution.
', 'ProcessingJob$FailureReason' => 'A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
', 'ProcessingJobSummary$FailureReason' => 'A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
', 'ResourceInUse$Message' => NULL, 'ResourceLimitExceeded$Message' => NULL, 'ResourceNotFound$Message' => NULL, 'TrainingJob$FailureReason' => 'If the training job failed, the reason it failed.
', 'TransformJob$FailureReason' => 'If the transform job failed, the reason it failed.
', 'TransformJobSummary$FailureReason' => 'If the transform job failed, the reason it failed.
', ], ], 'FeatureAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureGroupRequest$FeatureAdditions' => '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.
', ], ], 'FeatureDefinition' => [ 'base' => 'A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.
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.
A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.
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 description you added to describe the feature.
', 'FeatureMetadata$Description' => 'An optional description that you specify to better describe the feature.
', 'UpdateFeatureMetadataRequest$Description' => 'A description that you can write to better describe the feature.
', ], ], 'FeatureGroup' => [ 'base' => '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.
', 'refs' => [ 'SearchRecord$FeatureGroup' => NULL, ], ], 'FeatureGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupResponse$FeatureGroupArn' => 'The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.
The Amazon Resource Name (ARN) of the FeatureGroup.
The Amazon Resource Number (ARN) of the feature group that contains the feature.
', 'FeatureGroup$FeatureGroupArn' => 'The Amazon Resource Name (ARN) of a FeatureGroup.
Unique identifier for the FeatureGroup.
The Amazon Resource Number (ARN) of the feature group.
', 'UpdateFeatureGroupResponse$FeatureGroupArn' => 'The Amazon Resource Number (ARN) of the feature group that you\'re updating.
', ], ], 'FeatureGroupMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$MaxResults' => 'The maximum number of results returned by ListFeatureGroups.
The 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 and end with an alphanumeric character.
Can only contain alphanumeric character and hyphens. Spaces are not allowed.
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.
he name of the FeatureGroup.
The name of the feature group that you\'ve specified.
', 'FeatureGroup$FeatureGroupName' => 'The name of the FeatureGroup.
The name of FeatureGroup.
The name of the feature group containing the feature.
', 'ProcessingFeatureStoreOutput$FeatureGroupName' => '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.
', ], ], 'FeatureGroupNameContains' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$NameContains' => 'A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.
The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.
The name or Amazon Resource Name (ARN) of the feature group containing the feature.
', 'UpdateFeatureGroupRequest$FeatureGroupName' => 'The name or Amazon Resource Name (ARN) of the feature group that you\'re updating.
', 'UpdateFeatureMetadataRequest$FeatureGroupName' => 'The name or Amazon Resource Name (ARN) of the feature group containing the feature that you\'re updating.
', ], ], 'FeatureGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortBy' => 'The value on which the feature group list is sorted.
', ], ], 'FeatureGroupSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortOrder' => 'The order in which feature groups are listed.
', ], ], 'FeatureGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$FeatureGroupStatus' => 'The status of the feature group.
', 'FeatureGroup$FeatureGroupStatus' => 'A FeatureGroup status.
The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.
A FeatureGroup status. Filters by FeatureGroup status.
A summary of feature groups.
', ], ], 'FeatureGroupSummary' => [ 'base' => '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 is updated automatically.
', 'refs' => [ 'SearchRecord$FeatureMetadata' => 'The feature metadata used to search through the features.
', ], ], 'FeatureName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$RecordIdentifierFeatureName' => 'The 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 and end 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 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.
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 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.
The name of the feature.
', 'DescribeFeatureMetadataResponse$FeatureName' => 'The name of the feature that you\'ve specified.
', 'FeatureDefinition$FeatureName' => 'The 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 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 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.
The name of feature.
', 'UpdateFeatureMetadataRequest$FeatureName' => 'The name of the feature that you\'re updating.
', ], ], 'FeatureParameter' => [ 'base' => 'A key-value pair that you specify to describe the feature.
', 'refs' => [ 'FeatureParameterAdditions$member' => NULL, 'FeatureParameters$member' => NULL, ], ], 'FeatureParameterAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterAdditions' => 'A list of key-value pairs that you can add to better describe the feature.
', ], ], 'FeatureParameterKey' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Key' => 'A key that must contain a value to describe the feature.
', 'FeatureParameterRemovals$member' => NULL, ], ], 'FeatureParameterRemovals' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterRemovals' => 'A list of parameter keys that you can specify to remove parameters that describe your feature.
', ], ], 'FeatureParameterValue' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Value' => 'The value that belongs to a key.
', ], ], 'FeatureParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Parameters' => 'The key-value pairs that you added to describe the feature.
', 'FeatureMetadata$Parameters' => 'Optional key-value pairs that you specify to better describe the feature.
', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'ModelRegisterSettings$Status' => 'Describes whether the integration to the model registry is enabled or disabled in the Canvas application.
', 'TimeSeriesForecastingSettings$Status' => 'Describes whether time series forecasting is enabled or disabled in the Canvas application.
', ], ], 'FeatureType' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$FeatureType' => 'The data type of the feature.
', 'FeatureDefinition$FeatureType' => 'The value type of a feature. Valid values are Integral, Fractional, or String.
', 'FeatureMetadata$FeatureType' => 'The data type of the feature.
', ], ], 'FileSource' => [ 'base' => 'Contains details regarding the file source.
', 'refs' => [ 'DriftCheckBias$ConfigFile' => 'The bias config file for a model.
', 'DriftCheckExplainability$ConfigFile' => 'The explainability config file for the model.
', ], ], 'FileSystemAccessMode' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemAccessMode' => '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.
The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
', 'refs' => [ 'KernelGatewayImageConfig$FileSystemConfig' => 'The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
', ], ], 'FileSystemDataSource' => [ 'base' => 'Specifies a file system data source for a channel.
', 'refs' => [ 'DataSource$FileSystemDataSource' => 'The file system that is associated with a channel.
', ], ], 'FileSystemId' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemId' => 'The file system id.
', ], ], 'FileSystemType' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemType' => 'The file system type.
', ], ], 'FillingTransformationMap' => [ 'base' => NULL, 'refs' => [ 'FillingTransformations$value' => NULL, ], ], 'FillingTransformationValue' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$value' => NULL, ], ], 'FillingTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Filling' => '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 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>.
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 filter objects.
', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'Filter$Value' => '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.
The best candidate result from an AutoML training job.
', 'refs' => [ 'AutoMLCandidate$FinalAutoMLJobObjectiveMetric' => NULL, ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'base' => '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 FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
', ], ], 'FinalMetricDataList' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$FinalMetricDataList' => 'A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.
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.
', ], ], 'FlatInvocations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$FlatInvocations' => '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.
The value of the metric.
', 'MetricDatum$Value' => 'The value of the metric.
', 'RecommendationMetrics$CostPerHour' => 'Defines the cost per hour for the instance.
', 'RecommendationMetrics$CostPerInference' => 'Defines the cost per inference for the instance .
', ], ], 'FlowDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionResponse$FlowDefinitionArn' => 'The Amazon Resource Name (ARN) of the flow definition you create.
', 'DescribeFlowDefinitionResponse$FlowDefinitionArn' => 'The Amazon Resource Name (ARN) of the flow defintion.
', 'FlowDefinitionSummary$FlowDefinitionArn' => 'The Amazon Resource Name (ARN) of the flow definition.
', ], ], 'FlowDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionRequest$FlowDefinitionName' => 'The name of your flow definition.
', 'DeleteFlowDefinitionRequest$FlowDefinitionName' => 'The name of the flow definition you are deleting.
', 'DescribeFlowDefinitionRequest$FlowDefinitionName' => 'The name of the flow definition.
', 'DescribeFlowDefinitionResponse$FlowDefinitionName' => 'The Amazon Resource Name (ARN) of the flow definition.
', 'FlowDefinitionSummary$FlowDefinitionName' => 'The name of the flow definition.
', ], ], 'FlowDefinitionOutputConfig' => [ 'base' => 'Contains information about where human output will be stored.
', 'refs' => [ 'CreateFlowDefinitionRequest$OutputConfig' => 'An object containing information about where the human review results will be uploaded.
', 'DescribeFlowDefinitionResponse$OutputConfig' => 'An object containing information about the output file.
', ], ], 'FlowDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowDefinitionResponse$FlowDefinitionStatus' => 'The status of the flow definition. Valid values are listed below.
', 'FlowDefinitionSummary$FlowDefinitionStatus' => 'The status of the flow definition. Valid values:
', ], ], 'FlowDefinitionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFlowDefinitionsResponse$FlowDefinitionSummaries' => 'An array of objects describing the flow definitions.
', ], ], 'FlowDefinitionSummary' => [ 'base' => 'Contains summary information about the flow definition.
', 'refs' => [ 'FlowDefinitionSummaries$member' => NULL, ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskAvailabilityLifetimeInSeconds' => 'The length of time that a task remains available for review by human workers.
', ], ], 'FlowDefinitionTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskCount' => '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.
A description for the human worker task.
', ], ], 'FlowDefinitionTaskKeyword' => [ 'base' => NULL, 'refs' => [ 'FlowDefinitionTaskKeywords$member' => NULL, ], ], 'FlowDefinitionTaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskKeywords' => 'Keywords used to describe the task so that workers can discover the task.
', ], ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTimeLimitInSeconds' => 'The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
', ], ], 'FlowDefinitionTaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTitle' => 'A title for the human worker task.
', ], ], 'ForecastFrequency' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastFrequency' => 'The 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 the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.
', ], ], 'ForecastQuantile' => [ 'base' => NULL, 'refs' => [ 'ForecastQuantiles$member' => NULL, ], ], 'ForecastQuantiles' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastQuantiles' => '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.
Identifies the framework in which the model was trained. For example: TENSORFLOW.
', ], ], 'FrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'InputConfig$FrameworkVersion' => '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.
', ], ], 'GenerateCandidateDefinitionsOnly' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$GenerateCandidateDefinitionsOnly' => 'Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
', 'DescribeAutoMLJobResponse$GenerateCandidateDefinitionsOnly' => 'Indicates whether the output for an AutoML job generates candidate definitions only.
', 'TabularJobConfig$GenerateCandidateDefinitionsOnly' => 'Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
', ], ], 'GetDeviceFleetReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDeviceFleetReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GitConfig' => [ 'base' => 'Specifies configuration details for a Git repository in your Amazon Web Services account.
', 'refs' => [ 'CodeRepositorySummary$GitConfig' => '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.
', 'CreateCodeRepositoryInput$GitConfig' => 'Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.
', 'DescribeCodeRepositoryOutput$GitConfig' => '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.
', ], ], 'GitConfigForUpdate' => [ 'base' => 'Specifies configuration details for a Git repository when the repository is updated.
', 'refs' => [ 'UpdateCodeRepositoryInput$GitConfig' => '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}
The URL where the Git repository is located.
', ], ], 'Group' => [ 'base' => NULL, 'refs' => [ 'Groups$member' => NULL, ], ], 'GroupingAttributeName' => [ 'base' => NULL, 'refs' => [ 'GroupingAttributeNames$member' => NULL, ], ], 'GroupingAttributeNames' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$GroupingAttributeNames' => '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.
', ], ], 'Groups' => [ 'base' => NULL, 'refs' => [ 'OidcMemberDefinition$Groups' => '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.
', ], ], 'HookParameters' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$HookParameters' => 'Configuration information for the Amazon SageMaker Debugger hook parameters.
', ], ], 'Horovod' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Horovod' => 'Indicates Horovod compatibility.
', 'DescribeImageVersionResponse$Horovod' => 'Indicates Horovod compatibility.
', 'UpdateImageVersionRequest$Horovod' => 'Indicates Horovod compatibility.
', ], ], 'HubArn' => [ 'base' => NULL, 'refs' => [ 'CreateHubResponse$HubArn' => 'The Amazon Resource Name (ARN) of the hub.
', 'DescribeHubContentResponse$HubArn' => 'The Amazon Resource Name (ARN) of the hub that contains the content.
', 'DescribeHubResponse$HubArn' => 'The Amazon Resource Name (ARN) of the hub.
', 'HubInfo$HubArn' => 'The Amazon Resource Name (ARN) of the hub.
', 'ImportHubContentResponse$HubArn' => 'The ARN of the hub that the content was imported into.
', 'UpdateHubResponse$HubArn' => 'The Amazon Resource Name (ARN) of the updated hub.
', ], ], 'HubContentArn' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentArn' => 'The Amazon Resource Name (ARN) of the hub content.
', 'HubContentInfo$HubContentArn' => 'The Amazon Resource Name (ARN) of the hub content.
', 'ImportHubContentResponse$HubContentArn' => 'The ARN of the hub content that was imported.
', ], ], 'HubContentDependency' => [ 'base' => 'Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.
', 'refs' => [ 'HubContentDependencyList$member' => NULL, ], ], 'HubContentDependencyList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDependencies' => 'The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
', ], ], 'HubContentDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDescription' => 'A description of the hub content.
', 'HubContentInfo$HubContentDescription' => 'A description of the hub content.
', 'ImportHubContentRequest$HubContentDescription' => 'A description of the hub content to import.
', ], ], 'HubContentDisplayName' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDisplayName' => 'The display name of the hub content.
', 'HubContentInfo$HubContentDisplayName' => 'The display name of the hub content.
', 'ImportHubContentRequest$HubContentDisplayName' => 'The display name of the hub content to import.
', ], ], 'HubContentDocument' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDocument' => 'The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
', 'ImportHubContentRequest$HubContentDocument' => 'The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
', ], ], 'HubContentInfo' => [ 'base' => 'Information about hub content.
', 'refs' => [ 'HubContentInfoList$member' => NULL, ], ], 'HubContentInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsResponse$HubContentSummaries' => 'The summaries of the listed hub content versions.
', 'ListHubContentsResponse$HubContentSummaries' => 'The summaries of the listed hub content.
', ], ], 'HubContentMarkdown' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentMarkdown' => 'A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
', 'ImportHubContentRequest$HubContentMarkdown' => 'A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
', ], ], 'HubContentName' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentName' => 'The name of the content that you want to delete from a hub.
', 'DescribeHubContentRequest$HubContentName' => 'The name of the content to describe.
', 'DescribeHubContentResponse$HubContentName' => 'The name of the hub content.
', 'HubContentInfo$HubContentName' => 'The name of the hub content.
', 'ImportHubContentRequest$HubContentName' => 'The name of the hub content to import.
', 'ListHubContentVersionsRequest$HubContentName' => 'The name of the hub content.
', ], ], 'HubContentSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentSearchKeywords' => 'The searchable keywords for the hub content.
', 'HubContentInfo$HubContentSearchKeywords' => 'The searchable keywords for the hub content.
', 'ImportHubContentRequest$HubContentSearchKeywords' => 'The searchable keywords of the hub content.
', ], ], 'HubContentSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsRequest$SortBy' => 'Sort hub content versions by either name or creation time.
', 'ListHubContentsRequest$SortBy' => 'Sort hub content versions by either name or creation time.
', ], ], 'HubContentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentStatus' => 'The status of the hub content.
', 'HubContentInfo$HubContentStatus' => 'The status of the hub content.
', ], ], 'HubContentType' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentType' => 'The type of content that you want to delete from a hub.
', 'DescribeHubContentRequest$HubContentType' => 'The type of content in the hub.
', 'DescribeHubContentResponse$HubContentType' => 'The type of hub content.
', 'HubContentInfo$HubContentType' => 'The type of hub content.
', 'ImportHubContentRequest$HubContentType' => 'The type of hub content to import.
', 'ListHubContentVersionsRequest$HubContentType' => 'The type of hub content to list versions of.
', 'ListHubContentsRequest$HubContentType' => 'The type of hub content to list.
', ], ], 'HubContentVersion' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentVersion' => 'The version of the content that you want to delete from a hub.
', 'DescribeHubContentRequest$HubContentVersion' => 'The version of the content to describe.
', 'DescribeHubContentResponse$HubContentVersion' => 'The version of the hub content.
', 'HubContentInfo$HubContentVersion' => 'The version of the hub content.
', 'ImportHubContentRequest$HubContentVersion' => 'The version of the hub content to import.
', 'ListHubContentVersionsRequest$MinVersion' => 'The lower bound of the hub content versions to list.
', ], ], 'HubDescription' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDescription' => 'A description of the hub.
', 'DescribeHubResponse$HubDescription' => 'A description of the hub.
', 'HubInfo$HubDescription' => 'A description of the hub.
', 'UpdateHubRequest$HubDescription' => 'A description of the updated hub.
', ], ], 'HubDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDisplayName' => 'The display name of the hub.
', 'DescribeHubResponse$HubDisplayName' => 'The display name of the hub.
', 'HubInfo$HubDisplayName' => 'The display name of the hub.
', 'UpdateHubRequest$HubDisplayName' => 'The display name of the hub.
', ], ], 'HubInfo' => [ 'base' => 'Information about a hub.
', 'refs' => [ 'HubInfoList$member' => NULL, ], ], 'HubInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubsResponse$HubSummaries' => 'The summaries of the listed hubs.
', ], ], 'HubName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubName' => 'The name of the hub to create.
', 'DeleteHubContentRequest$HubName' => 'The name of the hub that you want to delete content in.
', 'DeleteHubRequest$HubName' => 'The name of the hub to delete.
', 'DescribeHubContentRequest$HubName' => 'The name of the hub that contains the content to describe.
', 'DescribeHubContentResponse$HubName' => 'The name of the hub that contains the content.
', 'DescribeHubRequest$HubName' => 'The name of the hub to describe.
', 'DescribeHubResponse$HubName' => 'The name of the hub.
', 'HubInfo$HubName' => 'The name of the hub.
', 'ImportHubContentRequest$HubName' => 'The name of the hub to import content into.
', 'ListHubContentVersionsRequest$HubName' => 'The name of the hub to list the content versions of.
', 'ListHubContentsRequest$HubName' => 'The name of the hub to list the contents of.
', 'UpdateHubRequest$HubName' => 'The name of the hub to update.
', ], ], 'HubS3StorageConfig' => [ 'base' => 'The Amazon S3 storage configuration of a hub.
', 'refs' => [ 'CreateHubRequest$S3StorageConfig' => 'The Amazon S3 storage configuration for the hub.
', 'DescribeHubResponse$S3StorageConfig' => 'The Amazon S3 storage configuration for the hub.
', ], ], 'HubSearchKeyword' => [ 'base' => NULL, 'refs' => [ 'HubContentSearchKeywordList$member' => NULL, 'HubSearchKeywordList$member' => NULL, ], ], 'HubSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubSearchKeywords' => 'The searchable keywords for the hub.
', 'DescribeHubResponse$HubSearchKeywords' => 'The searchable keywords for the hub.
', 'HubInfo$HubSearchKeywords' => 'The searchable keywords for the hub.
', 'UpdateHubRequest$HubSearchKeywords' => 'The searchable keywords for the hub.
', ], ], 'HubSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubsRequest$SortBy' => 'Sort hubs by either name or creation time.
', ], ], 'HubStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubResponse$HubStatus' => 'The status of the hub.
', 'HubInfo$HubStatus' => 'The status of the hub.
', ], ], 'HumanLoopActivationConditions' => [ 'base' => NULL, 'refs' => [ 'HumanLoopActivationConditionsConfig$HumanLoopActivationConditions' => '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.
', ], ], 'HumanLoopActivationConditionsConfig' => [ 'base' => 'Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.
', 'refs' => [ 'HumanLoopActivationConfig$HumanLoopActivationConditionsConfig' => 'Container structure for defining under what conditions SageMaker creates a human loop.
', ], ], 'HumanLoopActivationConfig' => [ 'base' => 'Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.
An object containing information about the events that trigger a human workflow.
', 'DescribeFlowDefinitionResponse$HumanLoopActivationConfig' => 'An object containing information about what triggers a human review workflow.
', ], ], 'HumanLoopConfig' => [ 'base' => 'Describes the work to be performed by human workers.
', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopConfig' => 'An object containing information about the tasks the human reviewers will perform.
', 'DescribeFlowDefinitionResponse$HumanLoopConfig' => 'An object containing information about who works on the task, the workforce task price, and other task details.
', ], ], 'HumanLoopRequestSource' => [ 'base' => 'Container for configuring the source of human task requests.
', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopRequestSource' => 'Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
', 'DescribeFlowDefinitionResponse$HumanLoopRequestSource' => 'Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
', ], ], 'HumanTaskConfig' => [ 'base' => 'Information required for human workers to complete a labeling task.
', 'refs' => [ 'CreateLabelingJobRequest$HumanTaskConfig' => 'Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
', 'DescribeLabelingJobResponse$HumanTaskConfig' => 'Configuration information required for human workers to complete a labeling task.
', ], ], 'HumanTaskUiArn' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiResponse$HumanTaskUiArn' => 'The Amazon Resource Name (ARN) of the human review workflow user interface you create.
', 'DescribeHumanTaskUiResponse$HumanTaskUiArn' => 'The Amazon Resource Name (ARN) of the human task user interface (worker task template).
', 'HumanLoopConfig$HumanTaskUiArn' => '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.
', 'HumanTaskUiSummary$HumanTaskUiArn' => 'The Amazon Resource Name (ARN) of the human task user interface.
', 'RenderUiTemplateRequest$HumanTaskUiArn' => '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.
', 'UiConfig$HumanTaskUiArn' => '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
The name of the user interface you are creating.
', 'DeleteHumanTaskUiRequest$HumanTaskUiName' => 'The name of the human task user interface (work task template) you want to delete.
', 'DescribeHumanTaskUiRequest$HumanTaskUiName' => 'The name of the human task user interface (worker task template) you want information about.
', 'DescribeHumanTaskUiResponse$HumanTaskUiName' => 'The name of the human task user interface (worker task template).
', 'HumanTaskUiSummary$HumanTaskUiName' => 'The name of the human task user interface.
', ], ], 'HumanTaskUiStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHumanTaskUiResponse$HumanTaskUiStatus' => 'The status of the human task user interface (worker task template). Valid values are listed below.
', ], ], 'HumanTaskUiSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHumanTaskUisResponse$HumanTaskUiSummaries' => 'An array of objects describing the human task user interfaces.
', ], ], 'HumanTaskUiSummary' => [ 'base' => 'Container for human task user interface information.
', 'refs' => [ 'HumanTaskUiSummaries$member' => NULL, ], ], 'HyperParameterAlgorithmSpecification' => [ 'base' => 'Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.
', 'refs' => [ 'HyperParameterTrainingJobDefinition$AlgorithmSpecification' => 'The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
', ], ], 'HyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameters$key' => NULL, ], ], 'HyperParameterScalingType' => [ 'base' => NULL, 'refs' => [ 'ContinuousParameterRange$ScalingType' => 'The 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.
The 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.
Defines a hyperparameter to be used by an algorithm.
', 'refs' => [ 'HyperParameterSpecifications$member' => NULL, ], ], 'HyperParameterSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedHyperParameters' => 'A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>
Defines the training jobs launched by a hyperparameter tuning job.
', 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinition' => '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.
', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinition' => 'The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
', 'HyperParameterTrainingJobDefinitions$member' => NULL, 'HyperParameterTuningJobSearchEntity$TrainingJobDefinition' => NULL, ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$DefinitionName' => 'The job definition name.
', 'HyperParameterTrainingJobSummary$TrainingJobDefinitionName' => 'The training job definition name.
', ], ], 'HyperParameterTrainingJobDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinitions' => 'A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions' => 'A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
', 'HyperParameterTuningJobSearchEntity$TrainingJobDefinitions' => 'The job definitions included in a hyperparameter tuning job.
', ], ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$key' => NULL, ], ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$Environment' => '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.
A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.
The container for the summary information about a training job.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$BestTrainingJob' => 'A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
', 'DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob' => '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 strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.
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).
', 'refs' => [ 'HyperParameterTuningInstanceConfigs$member' => NULL, ], ], 'HyperParameterTuningInstanceConfigs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$InstanceConfigs' => '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 Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => 'The Amazon Resource Name (ARN) of the tuning job.
', 'DescribeTrainingJobResponse$TuningJobArn' => 'The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobArn' => 'The Amazon Resource Name (ARN) of a hyperparameter tuning job.
', 'HyperParameterTuningJobSummary$HyperParameterTuningJobArn' => 'The Amazon Resource Name (ARN) of the tuning job.
', 'TrainingJob$TuningJobArn' => 'The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
', 'TuningJobStepMetaData$Arn' => 'The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
', ], ], 'HyperParameterTuningJobCompletionDetails' => [ 'base' => 'A structure that contains runtime information about both current and completed hyperparameter tuning jobs.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TuningJobCompletionDetails' => '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.
', 'HyperParameterTuningJobSearchEntity$TuningJobCompletionDetails' => 'Information about either a current or completed hyperparameter tuning job.
', ], ], 'HyperParameterTuningJobConfig' => [ 'base' => 'Configures a hyperparameter tuning job.
', 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig' => '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.
', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig' => 'The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobConfig' => NULL, ], ], 'HyperParameterTuningJobConsumedResources' => [ 'base' => 'The total resources consumed by your hyperparameter tuning job.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ConsumedResources' => NULL, 'HyperParameterTuningJobSearchEntity$ConsumedResources' => 'The total amount of resources consumed by a hyperparameter tuning job.
', ], ], 'HyperParameterTuningJobName' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '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.
', 'DescribeHyperParameterTuningJobRequest$HyperParameterTuningJobName' => 'The name of the tuning job.
', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobName' => 'The name of the hyperparameter tuning job.
', 'HyperParameterTrainingJobSummary$TuningJobName' => 'The HyperParameter tuning job that launched the training job.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobName' => 'The name of a hyperparameter tuning job.
', 'HyperParameterTuningJobSummary$HyperParameterTuningJobName' => 'The name of the tuning job.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$HyperParameterTuningJobName' => 'The name of the tuning job whose training jobs you want to list.
', 'ParentHyperParameterTuningJob$HyperParameterTuningJobName' => 'The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
', 'StopHyperParameterTuningJobRequest$HyperParameterTuningJobName' => 'The name of the tuning job to stop.
', ], ], 'HyperParameterTuningJobObjective' => [ 'base' => '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.
The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.
', 'HyperParameterTuningJobObjectives$member' => NULL, ], ], 'HyperParameterTuningJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$Type' => 'Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
', 'HyperParameterTuningJobObjective$Type' => 'Whether to minimize or maximize the objective metric.
', ], ], 'HyperParameterTuningJobObjectives' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTuningJobObjectiveMetrics' => 'A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.
', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'base' => 'An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.
', 'refs' => [ 'SearchRecord$HyperParameterTuningJob' => 'The properties of a hyperparameter tuning job.
', ], ], 'HyperParameterTuningJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsRequest$SortBy' => 'The field to sort results by. The default is Name.
The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobStatus' => 'The status of a hyperparameter tuning job.
', 'HyperParameterTuningJobSummary$HyperParameterTuningJobStatus' => 'The status of the tuning job.
', 'ListHyperParameterTuningJobsRequest$StatusEquals' => 'A filter that returns only tuning jobs with the specified status.
', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'base' => '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 configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.
The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.
', 'refs' => [ 'HyperParameterTuningJobConfig$Strategy' => '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.
', 'HyperParameterTuningJobSummary$Strategy' => 'Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.
', ], ], 'HyperParameterTuningJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsResponse$HyperParameterTuningJobSummaries' => 'A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.
Provides summary information about a hyperparameter tuning job.
', 'refs' => [ 'HyperParameterTuningJobSummaries$member' => NULL, ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'base' => 'Specifies 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.
Specifies 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.
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.
', 'HyperParameterTuningJobSearchEntity$WarmStartConfig' => NULL, ], ], 'HyperParameterTuningJobWarmStartType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$WarmStartType' => 'Specifies 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.
The maximum time in seconds that a hyperparameter tuning job can run.
', ], ], 'HyperParameterTuningResourceConfig' => [ 'base' => '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 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).
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
', 'HyperParameters$value' => NULL, ], ], 'HyperParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$HyperParameters' => 'Algorithm-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 field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
Algorithm-specific parameters.
', 'HyperParameterTrainingJobDefinition$StaticHyperParameters' => 'Specifies the values of hyperparameters that do not change for the tuning job.
', 'HyperParameterTrainingJobSummary$TunedHyperParameters' => 'A list of the hyperparameters for which you specified ranges to search.
', 'TrainingJob$HyperParameters' => 'Algorithm-specific parameters.
', 'TrainingJobDefinition$HyperParameters' => 'The hyperparameters used for the training job.
', ], ], 'HyperbandStrategyConfig' => [ 'base' => '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 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 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, HyperbandTrainingJ 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 distributive 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 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 IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.
', 'refs' => [ 'UserContext$IamIdentity' => 'The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
', ], ], 'IdempotencyToken' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
', 'DeletePipelineRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
', 'RetryPipelineExecutionRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
', 'SendPipelineExecutionStepFailureRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
', 'SendPipelineExecutionStepSuccessRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
', 'StartPipelineExecutionRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
', 'StopPipelineExecutionRequest$ClientRequestToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
', ], ], 'Image' => [ 'base' => 'A SageMaker image. A SageMaker 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 ImageVersion.
The ARN of the image.
', 'DescribeImageResponse$ImageArn' => 'The ARN of the image.
', 'DescribeImageVersionResponse$ImageArn' => 'The ARN of the image the version is based on.
', 'Image$ImageArn' => 'The ARN of the image.
', 'ImageVersion$ImageArn' => 'The ARN of the image the version is based on.
', 'ResourceSpec$SageMakerImageArn' => 'The ARN of the SageMaker image that the image version belongs to.
', 'UpdateImageResponse$ImageArn' => 'The ARN of the image.
', ], ], 'ImageBaseImage' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$BaseImage' => 'The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
The registry path of the container image on which this image version is based.
', ], ], 'ImageClassificationJobConfig' => [ 'base' => 'Stores the configuration information for the image classification problem of an AutoML job V2.
', 'refs' => [ 'AutoMLProblemTypeConfig$ImageClassificationJobConfig' => 'Settings used to configure an AutoML job V2 for the image classification problem type.
', ], ], 'ImageConfig' => [ 'base' => 'Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).
', 'refs' => [ 'ContainerDefinition$ImageConfig' => 'Specifies 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 registry path of the container image that contains this image version.
', ], ], 'ImageDeleteProperty' => [ 'base' => NULL, 'refs' => [ 'ImageDeletePropertyList$member' => NULL, ], ], 'ImageDeletePropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateImageRequest$DeleteProperties' => 'A list of properties to delete. Only the Description and DisplayName properties can be deleted.
The description of the image.
', 'DescribeImageResponse$Description' => 'The description of the image.
', 'Image$Description' => 'The description of the image.
', 'UpdateImageRequest$Description' => 'The new description for the image.
', ], ], 'ImageDigest' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$ImageDigest' => 'An MD5 hash of the training algorithm that identifies the Docker image used for training.
', 'TrainingSpecification$TrainingImageDigest' => 'An MD5 hash of the training algorithm that identifies the Docker image used for training.
', ], ], 'ImageDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$DisplayName' => 'The display name of the image. If not provided, ImageName is displayed.
The name of the image as displayed.
', 'Image$DisplayName' => 'The name of the image as displayed.
', 'UpdateImageRequest$DisplayName' => 'The new display name for the image.
', ], ], 'ImageName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$ImageName' => 'The name of the image. Must be unique to your account.
', 'CreateImageVersionRequest$ImageName' => 'The ImageName of the Image to create a version of.
The name of the CustomImage. Must be unique to your account.
', 'DeleteImageRequest$ImageName' => 'The name of the image to delete.
', 'DeleteImageVersionRequest$ImageName' => 'The name of the image to delete.
', 'DescribeImageRequest$ImageName' => 'The name of the image to describe.
', 'DescribeImageResponse$ImageName' => 'The name of the image.
', 'DescribeImageVersionRequest$ImageName' => 'The name of the image.
', 'Image$ImageName' => 'The name of the image.
', 'ListAliasesRequest$ImageName' => 'The name of the image.
', 'ListImageVersionsRequest$ImageName' => 'The name of the image to list the versions of.
', 'UpdateImageRequest$ImageName' => 'The name of the image to update.
', 'UpdateImageVersionRequest$ImageName' => 'The name of the image.
', ], ], 'ImageNameContains' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$NameContains' => 'A filter that returns only images whose name contains the specified string.
', ], ], 'ImageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortBy' => 'The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
The status of the image.
', 'Image$ImageStatus' => 'The status of the image.
', ], ], 'ImageUri' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ImageUri' => 'The container image to be run by the processing job.
', 'DataQualityAppSpecification$ImageUri' => 'The container image that the data quality monitoring job runs.
', 'ModelBiasAppSpecification$ImageUri' => 'The container image to be run by the model bias job.
', 'ModelExplainabilityAppSpecification$ImageUri' => 'The container image to be run by the model explainability job.
', 'ModelQualityAppSpecification$ImageUri' => 'The address of the container image that the monitoring job runs.
', 'MonitoringAppSpecification$ImageUri' => 'The container image to be run by the monitoring job.
', ], ], 'ImageVersion' => [ 'base' => 'A version of a SageMaker Image. A version represents an existing container image.
The ARN of the image version.
', 'DescribeImageVersionResponse$ImageVersionArn' => 'The ARN of the version.
', 'ImageVersion$ImageVersionArn' => 'The ARN of the version.
', 'ResourceSpec$SageMakerImageVersionArn' => 'The ARN of the image version created on the instance.
', 'UpdateImageVersionResponse$ImageVersionArn' => 'The ARN of the image version.
', ], ], 'ImageVersionNumber' => [ 'base' => NULL, 'refs' => [ 'CustomImage$ImageVersionNumber' => 'The version number of the CustomImage.
', 'DeleteImageVersionRequest$Version' => 'The version to delete.
', 'DescribeImageVersionRequest$Version' => 'The version of the image. If not specified, the latest version is described.
', 'DescribeImageVersionResponse$Version' => 'The version number.
', 'ImageVersion$Version' => 'The version number.
', 'ListAliasesRequest$Version' => 'The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
', 'UpdateImageVersionRequest$Version' => 'The version of the image.
', ], ], 'ImageVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortBy' => 'The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
The status of the version.
', 'ImageVersion$ImageVersionStatus' => 'The status of the version.
', ], ], 'ImageVersions' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsResponse$ImageVersions' => 'A list of versions and their properties.
', ], ], 'Images' => [ 'base' => NULL, 'refs' => [ 'ListImagesResponse$Images' => 'A list of images and their properties.
', ], ], 'ImportHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'InferenceExecutionConfig' => [ 'base' => 'Specifies details about how containers in a multi-container endpoint are run.
', 'refs' => [ 'CreateModelInput$InferenceExecutionConfig' => 'Specifies details of how containers in a multi-container endpoint are called.
', 'DescribeModelOutput$InferenceExecutionConfig' => 'Specifies details of how containers in a multi-container endpoint are called.
', 'Model$InferenceExecutionConfig' => NULL, ], ], 'InferenceExecutionMode' => [ 'base' => NULL, 'refs' => [ 'InferenceExecutionConfig$Mode' => '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.
The ARN for your inference experiment.
', 'DeleteInferenceExperimentResponse$InferenceExperimentArn' => 'The ARN of the deleted inference experiment.
', 'DescribeInferenceExperimentResponse$Arn' => 'The ARN of the inference experiment being described.
', 'StartInferenceExperimentResponse$InferenceExperimentArn' => 'The ARN of the started inference experiment to start.
', 'StopInferenceExperimentResponse$InferenceExperimentArn' => 'The ARN of the stopped inference experiment.
', 'UpdateInferenceExperimentResponse$InferenceExperimentArn' => 'The ARN of the updated inference experiment.
', ], ], 'InferenceExperimentDataStorageConfig' => [ 'base' => 'The Amazon S3 location and configuration for storing inference request and response data.
', 'refs' => [ 'CreateInferenceExperimentRequest$DataStorageConfig' => '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.
', 'DescribeInferenceExperimentResponse$DataStorageConfig' => 'The Amazon S3 location and configuration for storing inference request and response data.
', 'UpdateInferenceExperimentRequest$DataStorageConfig' => 'The Amazon S3 location and configuration for storing inference request and response data.
', ], ], 'InferenceExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Description' => 'A description for the inference experiment.
', 'DescribeInferenceExperimentResponse$Description' => 'The description of the inference experiment.
', 'InferenceExperimentSummary$Description' => 'The description of the inference experiment.
', 'UpdateInferenceExperimentRequest$Description' => 'The description of the inference experiment.
', ], ], 'InferenceExperimentList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsResponse$InferenceExperiments' => 'List of inference experiments.
', ], ], 'InferenceExperimentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Name' => 'The name for the inference experiment.
', 'DeleteInferenceExperimentRequest$Name' => 'The name of the inference experiment you want to delete.
', 'DescribeInferenceExperimentRequest$Name' => 'The name of the inference experiment to describe.
', 'DescribeInferenceExperimentResponse$Name' => 'The name of the inference experiment.
', 'InferenceExperimentSummary$Name' => 'The name of the inference experiment.
', 'StartInferenceExperimentRequest$Name' => 'The name of the inference experiment to start.
', 'StopInferenceExperimentRequest$Name' => 'The name of the inference experiment to stop.
', 'UpdateInferenceExperimentRequest$Name' => 'The name of the inference experiment to be updated.
', ], ], 'InferenceExperimentSchedule' => [ 'base' => 'The start and end times of an inference experiment.
The maximum duration that you can set for an inference experiment is 30 days.
', 'refs' => [ 'CreateInferenceExperimentRequest$Schedule' => '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.
', 'DescribeInferenceExperimentResponse$Schedule' => 'The duration for which the inference experiment ran or will run.
', 'InferenceExperimentSummary$Schedule' => '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.
', 'UpdateInferenceExperimentRequest$Schedule' => ' 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.
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.
The status of the inference experiment.
', 'ListInferenceExperimentsRequest$StatusEquals' => 'Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.
', ], ], 'InferenceExperimentStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$StatusReason' => ' The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
The error message for the inference experiment status result.
', 'StopInferenceExperimentRequest$Reason' => 'The reason for stopping the experiment.
', ], ], 'InferenceExperimentStopDesiredState' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$DesiredState' => 'The desired state of the experiment after stopping. The possible states are the following:
Completed: The experiment completed successfully
Cancelled: The experiment was canceled
Lists a summary of properties of an inference experiment.
', 'refs' => [ 'InferenceExperimentList$member' => NULL, ], ], 'InferenceExperimentType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Type' => '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.
The type of the inference experiment.
', 'InferenceExperimentSummary$Type' => 'The type of the inference experiment.
', 'ListInferenceExperimentsRequest$Type' => 'Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.
', ], ], 'InferenceImage' => [ 'base' => NULL, 'refs' => [ 'DescribeCompilationJobResponse$InferenceImage' => 'The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.
', ], ], 'InferenceMetrics' => [ 'base' => 'The metrics for an existing endpoint compared in an Inference Recommender job.
', 'refs' => [ 'EndpointPerformance$Metrics' => 'The metrics for an existing endpoint.
', 'RecommendationJobInferenceBenchmark$EndpointMetrics' => NULL, ], ], 'InferenceRecommendation' => [ 'base' => 'A list of recommendations made by Amazon SageMaker Inference Recommender.
', 'refs' => [ 'InferenceRecommendations$member' => NULL, ], ], 'InferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$InferenceRecommendations' => 'The recommendations made by Inference Recommender.
', ], ], 'InferenceRecommendationsJob' => [ 'base' => 'A structure that contains a list of recommendation jobs.
', 'refs' => [ 'InferenceRecommendationsJobs$member' => NULL, ], ], 'InferenceRecommendationsJobStep' => [ 'base' => 'A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.
A list of all subtask details in Inference Recommender.
', ], ], 'InferenceRecommendationsJobs' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsResponse$InferenceRecommendationsJobs' => 'The recommendations created from the Amazon SageMaker Inference Recommender job.
', ], ], 'InferenceSpecification' => [ 'base' => 'Defines how to perform inference generation after a training job is run.
', 'refs' => [ 'BatchDescribeModelPackageSummary$InferenceSpecification' => NULL, 'CreateAlgorithmInput$InferenceSpecification' => 'Specifies 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 details about inference jobs that can be run with models based on this model package, including the following:
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.
Details about inference jobs that the algorithm runs.
', 'DescribeModelPackageOutput$InferenceSpecification' => 'Details about inference jobs that can be run with models based on this model package.
', 'ModelPackage$InferenceSpecification' => 'Defines how to perform inference generation after a training job is run.
', ], ], 'InferenceSpecificationName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$InferenceSpecificationName' => 'The inference specification name in the model package version.
', 'EndpointInputConfiguration$InferenceSpecificationName' => 'The inference specification name in the model package version.
', 'ModelConfiguration$InferenceSpecificationName' => 'The inference specification name in the model package version.
', ], ], 'InitialInstanceCount' => [ 'base' => NULL, 'refs' => [ 'EndpointOutputConfiguration$InitialInstanceCount' => 'The number of instances recommended to launch initially.
', ], ], 'InitialNumberOfUsers' => [ 'base' => NULL, 'refs' => [ 'Phase$InitialNumberOfUsers' => 'Specifies how many concurrent users to start with. The value should be between 1 and 3.
', ], ], 'InitialTaskCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$InitialInstanceCount' => 'Number of instances to launch initially.
', ], ], 'InputConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateCompilationJobRequest$InputConfig' => '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.
', 'DescribeCompilationJobResponse$InputConfig' => '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.
', ], ], 'InputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$InputDataConfig' => '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.
', 'DescribeTrainingJobResponse$InputDataConfig' => 'An array of Channel objects that describes each data input channel.
An array of Channel objects that specify the input for the training jobs that the tuning job launches.
', 'TrainingJob$InputDataConfig' => '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.
', 'TrainingJobDefinition$InputDataConfig' => 'An array of Channel objects, each of which specifies an input source.
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.
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.
', ], ], 'InstanceGroup' => [ 'base' => 'Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .
', 'refs' => [ 'InstanceGroups$member' => NULL, ], ], 'InstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$InstanceGroupName' => 'Specifies the name of the instance group.
', 'InstanceGroupNames$member' => NULL, ], ], 'InstanceGroupNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$InstanceGroupNames' => 'A list of names of instance groups that get data from the S3 data source.
', ], ], 'InstanceGroups' => [ 'base' => NULL, 'refs' => [ 'ResourceConfig$InstanceGroups' => 'The configuration of a heterogeneous cluster in JSON format.
', ], ], 'InstanceMetadataServiceConfiguration' => [ 'base' => 'Information on the IMDS configuration of the notebook instance
', 'refs' => [ 'CreateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => 'Information on the IMDS configuration of the notebook instance
', 'DescribeNotebookInstanceOutput$InstanceMetadataServiceConfiguration' => 'Information on the IMDS configuration of the notebook instance
', 'UpdateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => 'Information on the IMDS configuration of the notebook instance
', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$InstanceType' => 'The type of ML compute instance to launch for the notebook instance.
', 'DescribeNotebookInstanceOutput$InstanceType' => 'The type of ML compute instance running on the notebook instance.
', 'NotebookInstanceSummary$InstanceType' => 'The type of ML compute instance that the notebook instance is running on.
', 'RealTimeInferenceConfig$InstanceType' => 'The instance type the model is deployed to.
', 'UpdateNotebookInstanceInput$InstanceType' => 'The Amazon ML compute instance type.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardVersion' => 'The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.
', 'DescribeDeviceResponse$MaxModels' => 'The maximum number of models.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentSuccess' => 'The number of edge devices with the successful deployment.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPending' => 'The number of edge devices yet to pick up deployment, or in progress.
', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentFailed' => 'The number of edge devices that failed the deployment.
', 'DescribeModelCardExportJobResponse$ModelCardVersion' => 'The version of the model card that the model export job exports.
', 'DescribeModelCardRequest$ModelCardVersion' => 'The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
', 'DescribeModelCardResponse$ModelCardVersion' => 'The version of the model card.
', 'DynamicScalingConfiguration$MinCapacity' => 'The recommended minimum capacity to specify for your autoscaling policy.
', 'DynamicScalingConfiguration$MaxCapacity' => 'The recommended maximum capacity to specify for your autoscaling policy.
', 'DynamicScalingConfiguration$ScaleInCooldown' => 'The recommended scale in cooldown time for your autoscaling policy.
', 'DynamicScalingConfiguration$ScaleOutCooldown' => 'The recommended scale out cooldown time for your autoscaling policy.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentSuccess' => 'The number of edge devices with the successful deployment.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentPending' => 'The number of edge devices yet to pick up the deployment, or in progress.
', 'EdgeDeploymentPlanSummary$EdgeDeploymentFailed' => 'The number of edge devices that failed the deployment.
', 'EdgeDeploymentStatus$EdgeDeploymentSuccessInStage' => 'The number of edge devices with the successful deployment in the current stage.
', 'EdgeDeploymentStatus$EdgeDeploymentPendingInStage' => 'The number of edge devices yet to pick up the deployment in current stage, or in progress.
', 'EdgeDeploymentStatus$EdgeDeploymentFailedInStage' => 'The number of edge devices that failed the deployment in current stage.
', 'HyperParameterTuningJobCompletionDetails$NumberOfTrainingJobsObjectiveNotImproving' => '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.
', 'HyperParameterTuningJobConsumedResources$RuntimeInSeconds' => 'The wall clock runtime in seconds used by your hyperparameter tuning job.
', 'InferenceMetrics$MaxInvocations' => 'The expected maximum number of requests per minute for the instance.
', 'InferenceMetrics$ModelLatency' => 'The expected model latency at maximum invocations per minute for the instance.
', 'ListModelCardExportJobsRequest$ModelCardVersion' => 'List export jobs for the model card with the specified version.
', 'ModelCard$ModelCardVersion' => 'The version of the model card.
', 'ModelCardExportJobSummary$ModelCardVersion' => 'The version of the model card that the export job exports.
', 'ModelCardVersionSummary$ModelCardVersion' => 'A version of the model card.
', 'ModelDashboardModelCard$ModelCardVersion' => 'The model card version.
', 'ModelLatencyThreshold$ValueInMilliseconds' => 'The model latency percentile value in milliseconds.
', 'RecommendationJobStoppingConditions$MaxInvocations' => 'The maximum number of requests per minute expected for the endpoint.
', 'RecommendationMetrics$MaxInvocations' => 'The expected maximum number of requests per minute for the instance.
', 'RecommendationMetrics$ModelLatency' => 'The expected model latency at maximum invocation per minute for the instance.
', 'ScalingPolicyMetric$InvocationsPerInstance' => '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. 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.
', 'ScalingPolicyObjective$MinInvocationsPerMinute' => 'The minimum number of expected requests to your endpoint per minute.
', 'ScalingPolicyObjective$MaxInvocationsPerMinute' => 'The maximum number of expected requests to your endpoint per minute.
', ], ], 'IntegerParameterRange' => [ 'base' => 'For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
', 'refs' => [ 'IntegerParameterRanges$member' => NULL, ], ], 'IntegerParameterRangeSpecification' => [ 'base' => 'Defines the possible values for an integer hyperparameter.
', 'refs' => [ 'ParameterRange$IntegerParameterRangeSpecification' => 'A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
', ], ], 'IntegerValue' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$AttemptCount' => 'The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
', ], ], 'InvocationEndTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationEndTime' => 'A timestamp that shows when the benchmark completed.
', 'RecommendationJobInferenceBenchmark$InvocationEndTime' => 'A timestamp that shows when the benchmark completed.
', ], ], 'InvocationStartTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationStartTime' => 'A timestamp that shows when the benchmark started.
', 'RecommendationJobInferenceBenchmark$InvocationStartTime' => 'A timestamp that shows when the benchmark started.
', ], ], 'InvocationsMaxRetries' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsMaxRetries' => 'The maximum number of retries when invocation requests are failing. The default value is 3.
', ], ], 'InvocationsTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsTimeoutInSeconds' => 'The timeout value in seconds for an invocation request. The default value is 600.
', ], ], 'IotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$IotRoleAlias' => 'The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).
', ], ], 'ItemIdentifierAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$ItemIdentifierAttributeName' => 'The name of the column that represents the set of item identifiers for which you want to predict the target value.
', ], ], 'JobDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$JobDurationInSeconds' => 'Specifies the maximum duration of the job, in seconds. The maximum value is 7200.
', ], ], 'JobReferenceCode' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$JobReferenceCode' => 'A unique identifier for work done as part of a labeling job.
', 'LabelingJobForWorkteamSummary$JobReferenceCode' => 'A unique identifier for a labeling job. You can use this to refer to a specific labeling job.
', ], ], 'JobReferenceCodeContains' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$JobReferenceCodeContains' => 'A filter the limits jobs to only the ones whose job reference code contains the specified string.
', ], ], 'JobType' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$JobType' => 'Indicates SageMaker job type compatibility.
TRAINING: The image version is compatible with SageMaker training jobs.
INFERENCE: The image version is compatible with SageMaker inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
Indicates SageMaker job type compatibility.
TRAINING: The image version is compatible with SageMaker training jobs.
INFERENCE: The image version is compatible with SageMaker inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
Indicates SageMaker job type compatibility.
TRAINING: The image version is compatible with SageMaker training jobs.
INFERENCE: The image version is compatible with SageMaker inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
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.
', ], ], 'JsonContentType' => [ 'base' => NULL, 'refs' => [ 'JsonContentTypes$member' => NULL, ], ], 'JsonContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$JsonContentTypes' => 'The list of all content type headers that SageMaker will treat as JSON and capture accordingly.
', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$InputFilter' => '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 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\']"
The JupyterServer app settings.
', 'refs' => [ 'DefaultSpaceSettings$JupyterServerAppSettings' => NULL, 'SpaceSettings$JupyterServerAppSettings' => NULL, 'UserSettings$JupyterServerAppSettings' => 'The Jupyter server\'s app settings.
', ], ], 'KeepAlivePeriodInSeconds' => [ 'base' => NULL, 'refs' => [ 'ResourceConfig$KeepAlivePeriodInSeconds' => 'The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.
', 'ResourceConfigForUpdate$KeepAlivePeriodInSeconds' => 'The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.
The display name of the kernel.
', ], ], 'KernelGatewayAppSettings' => [ 'base' => 'The KernelGateway app settings.
', 'refs' => [ 'DefaultSpaceSettings$KernelGatewayAppSettings' => NULL, 'SpaceSettings$KernelGatewayAppSettings' => NULL, 'UserSettings$KernelGatewayAppSettings' => 'The kernel gateway app settings.
', ], ], 'KernelGatewayImageConfig' => [ 'base' => 'The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.
', 'refs' => [ 'AppImageConfigDetails$KernelGatewayImageConfig' => 'The configuration for the file system and kernels in the SageMaker image.
', 'CreateAppImageConfigRequest$KernelGatewayImageConfig' => '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.
', 'DescribeAppImageConfigResponse$KernelGatewayImageConfig' => 'The configuration of a KernelGateway app.
', 'UpdateAppImageConfigRequest$KernelGatewayImageConfig' => 'The new KernelGateway app to run on the image.
', ], ], 'KernelName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$Name' => 'The name of the Jupyter kernel in the image. This value is case sensitive.
', ], ], 'KernelSpec' => [ 'base' => 'The specification of a Jupyter kernel.
', 'refs' => [ 'KernelSpecs$member' => NULL, ], ], 'KernelSpecs' => [ 'base' => NULL, 'refs' => [ 'KernelGatewayImageConfig$KernelSpecs' => 'The specification of the Jupyter kernels in the image.
', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$ObjectKey' => 'The object key (or key name) uniquely identifies the object in an S3 bucket.
', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$KmsKeyId' => 'The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.
', 'AthenaDatasetDefinition$KmsKeyId' => '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.
', 'AutoMLOutputDataConfig$KmsKeyId' => 'The Key Management Service (KMS) encryption key ID.
', 'AutoMLSecurityConfig$VolumeKmsKeyId' => 'The key used to encrypt stored data.
', 'BatchDataCaptureConfig$KmsKeyId' => '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
Use KmsKeyId.
SageMaker uses 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, specify a customer managed key.
', 'CreateEdgePackagingJobRequest$ResourceKey' => 'The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.
', 'CreateEndpointConfigInput$KmsKeyId' => '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 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.
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.
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 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.
', 'DataCaptureConfig$KmsKeyId' => 'The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker 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
The KMS key being used to encrypt the data in Amazon S3.
', 'DescribeDomainResponse$HomeEfsFileSystemKmsKeyId' => 'Use KmsKeyId.
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
', 'DescribeEdgePackagingJobResponse$ResourceKey' => 'The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.
', 'DescribeEndpointConfigOutput$KmsKeyId' => 'Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
', 'DescribeInferenceExperimentResponse$KmsKey' => '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.
', 'DescribeNotebookInstanceOutput$KmsKeyId' => 'The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
', 'EdgeOutputConfig$KmsKeyId' => '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.
', 'FlowDefinitionOutputConfig$KmsKeyId' => 'The Amazon Key Management Service (KMS) key ID for server-side encryption.
', 'HyperParameterTuningResourceConfig$VolumeKmsKeyId' => '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 Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.
', 'LabelingJobOutputConfig$KmsKeyId' => '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.
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"
A Key Management Service key ID to use for encrypting a model card.
', 'MonitoringClusterConfig$VolumeKmsKeyId' => '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 model monitoring job.
', 'MonitoringOutputConfig$KmsKeyId' => '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.
', 'OnlineStoreSecurityConfig$KmsKeyId' => '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"
The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker 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 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
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. 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 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.
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.
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, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
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.
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.
', 'RecommendationJobOutputConfig$KmsKeyId' => '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.
', 'RedshiftDatasetDefinition$KmsKeyId' => 'The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
', 'ResourceConfig$VolumeKmsKeyId' => '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 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"
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.
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.
', 'TransformResources$VolumeKmsKeyId' => '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
The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.
', ], ], 'LabelAttributeName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelAttributeName' => '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.
The attribute used as the label in the output manifest file.
', ], ], 'LabelCounter' => [ 'base' => NULL, 'refs' => [ 'LabelCounters$TotalLabeled' => 'The total number of objects labeled.
', 'LabelCounters$HumanLabeled' => 'The total number of objects labeled by a human worker.
', 'LabelCounters$MachineLabeled' => 'The total number of objects labeled by automated data labeling.
', 'LabelCounters$FailedNonRetryableError' => 'The total number of objects that could not be labeled due to an error.
', 'LabelCounters$Unlabeled' => 'The total number of objects not yet labeled.
', 'LabelCountersForWorkteam$HumanLabeled' => 'The total number of data objects labeled by a human worker.
', 'LabelCountersForWorkteam$PendingHuman' => 'The total number of data objects that need to be labeled by a human worker.
', 'LabelCountersForWorkteam$Total' => 'The total number of tasks in the labeling job.
', ], ], 'LabelCounters' => [ 'base' => 'Provides a breakdown of the number of objects labeled.
', 'refs' => [ 'DescribeLabelingJobResponse$LabelCounters' => '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.
', 'LabelingJobSummary$LabelCounters' => 'Counts showing the progress of the labeling job.
', ], ], 'LabelCountersForWorkteam' => [ 'base' => 'Provides counts for human-labeled tasks in the labeling job.
', 'refs' => [ 'LabelingJobForWorkteamSummary$LabelCounters' => 'Provides information about the progress of a labeling job.
', ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'base' => NULL, 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobAlgorithmSpecificationArn' => '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
Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.
Configures the information required to perform automated data labeling.
', 'DescribeLabelingJobResponse$LabelingJobAlgorithmsConfig' => 'Configuration information for automated data labeling.
', ], ], 'LabelingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobResponse$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.
', 'DescribeLabelingJobResponse$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the labeling job.
', 'DescribeTrainingJobResponse$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.
', 'DescribeTransformJobResponse$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
', 'LabelingJobSummary$LabelingJobArn' => 'The Amazon Resource Name (ARN) assigned to the labeling job when it was created.
', 'TrainingJob$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the labeling job.
', 'TransformJob$LabelingJobArn' => 'The Amazon Resource Name (ARN) of the labeling job that created the transform job.
', ], ], 'LabelingJobDataAttributes' => [ 'base' => 'Attributes of the data specified by the customer. Use these to describe the data to be labeled.
', 'refs' => [ 'LabelingJobInputConfig$DataAttributes' => 'Attributes of the data specified by the customer.
', ], ], 'LabelingJobDataSource' => [ 'base' => '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.
The location of the input data.
', ], ], 'LabelingJobForWorkteamSummary' => [ 'base' => 'Provides summary information for a work team.
', 'refs' => [ 'LabelingJobForWorkteamSummaryList$member' => NULL, ], ], 'LabelingJobForWorkteamSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamResponse$LabelingJobSummaryList' => 'An array of LabelingJobSummary objects, each describing a labeling job.
Input configuration information for a labeling job.
', 'refs' => [ 'CreateLabelingJobRequest$InputConfig' => '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.
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.
', 'LabelingJobSummary$InputConfig' => 'Input configuration for the labeling job.
', ], ], 'LabelingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelingJobName' => '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 name of the labeling job to return information for.
', 'DescribeLabelingJobResponse$LabelingJobName' => 'The name assigned to the labeling job when it was created.
', 'LabelingJobForWorkteamSummary$LabelingJobName' => 'The name of the labeling job that the work team is assigned to.
', 'LabelingJobSummary$LabelingJobName' => 'The name of the labeling job.
', 'StopLabelingJobRequest$LabelingJobName' => 'The name of the labeling job to stop.
', ], ], 'LabelingJobOutput' => [ 'base' => 'Specifies the location of the output produced by the labeling job.
', 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobOutput' => 'The location of the output produced by the labeling job.
', 'LabelingJobSummary$LabelingJobOutput' => 'The location of the output produced by the labeling job.
', ], ], 'LabelingJobOutputConfig' => [ 'base' => 'Output configuration information for a labeling job.
', 'refs' => [ 'CreateLabelingJobRequest$OutputConfig' => '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.
', 'DescribeLabelingJobResponse$OutputConfig' => '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.
', ], ], 'LabelingJobResourceConfig' => [ 'base' => 'Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.
', 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobResourceConfig' => 'Provides configuration information for a labeling job.
', ], ], 'LabelingJobS3DataSource' => [ 'base' => 'The Amazon S3 location of the input data objects.
', 'refs' => [ 'LabelingJobDataSource$S3DataSource' => 'The Amazon S3 location of the input data objects.
', ], ], 'LabelingJobSnsDataSource' => [ 'base' => 'An Amazon SNS data source used for streaming labeling jobs.
', 'refs' => [ 'LabelingJobDataSource$SnsDataSource' => 'An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.
', ], ], 'LabelingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobStatus' => 'The processing status of the labeling job.
', 'LabelingJobSummary$LabelingJobStatus' => 'The current status of the labeling job.
', 'ListLabelingJobsRequest$StatusEquals' => 'A filter that retrieves only labeling jobs with a specific status.
', ], ], 'LabelingJobStoppingConditions' => [ 'base' => 'A 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.
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.
', 'DescribeLabelingJobResponse$StoppingConditions' => 'A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
', ], ], 'LabelingJobSummary' => [ 'base' => 'Provides summary information about a labeling job.
', 'refs' => [ 'LabelingJobSummaryList$member' => NULL, ], ], 'LabelingJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsResponse$LabelingJobSummaryList' => 'An array of LabelingJobSummary objects, each describing a labeling job.
The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.
This parameter is required for all labeling jobs. 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 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
The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.
', 'LabelingJobSummary$AnnotationConsolidationLambdaArn' => '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.
', ], ], 'LambdaStepMetadata' => [ 'base' => 'Metadata for a Lambda step.
', 'refs' => [ 'PipelineExecutionStepMetadata$Lambda' => 'The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.
', ], ], 'LastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$LastModifiedTime' => 'The date and time that the Git repository was last modified.
', 'CompilationJobSummary$LastModifiedTime' => 'The time when the model compilation job was last modified.
', 'DescribeCodeRepositoryOutput$LastModifiedTime' => 'The date and time that the repository was last changed.
', 'DescribeCompilationJobResponse$LastModifiedTime' => 'The time that the status of the model compilation job was last modified.
', 'DescribeDomainResponse$LastModifiedTime' => 'The last modified time.
', 'DescribeFeatureGroupResponse$LastModifiedTime' => 'A timestamp indicating when the feature group was last updated.
', 'DescribeFeatureMetadataResponse$LastModifiedTime' => '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
', 'DescribeInferenceRecommendationsJobResponse$LastModifiedTime' => 'A timestamp that shows when the job was last modified.
', 'DescribeNotebookInstanceLifecycleConfigOutput$LastModifiedTime' => 'A timestamp that tells when the lifecycle configuration was last modified.
', 'DescribeNotebookInstanceOutput$LastModifiedTime' => 'A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
', 'DescribeSpaceResponse$LastModifiedTime' => 'The last modified time.
', 'DescribeUserProfileResponse$LastModifiedTime' => 'The last modified time.
', 'DomainDetails$LastModifiedTime' => 'The last modified time.
', 'FeatureGroup$LastModifiedTime' => 'A timestamp indicating the last time you updated the feature group.
', 'FeatureMetadata$LastModifiedTime' => 'A timestamp indicating when the feature was last modified.
', 'InferenceRecommendationsJob$LastModifiedTime' => 'A timestamp that shows when the job was last modified.
', 'ListCompilationJobsRequest$LastModifiedTimeAfter' => 'A filter that returns the model compilation jobs that were modified after a specified time.
', 'ListCompilationJobsRequest$LastModifiedTimeBefore' => 'A filter that returns the model compilation jobs that were modified before a specified time.
', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only jobs that were last modified after the specified time (timestamp).
', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only jobs that were last modified before the specified time (timestamp).
', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeBefore' => 'A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeAfter' => 'A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
', 'ListNotebookInstancesInput$LastModifiedTimeBefore' => 'A filter that returns only notebook instances that were modified before the specified time (timestamp).
', 'ListNotebookInstancesInput$LastModifiedTimeAfter' => 'A filter that returns only notebook instances that were modified after the specified time (timestamp).
', 'NotebookInstanceLifecycleConfigSummary$LastModifiedTime' => 'A timestamp that tells when the lifecycle configuration was last modified.
', 'NotebookInstanceSummary$LastModifiedTime' => 'A timestamp that shows when the notebook instance was last modified.
', 'SpaceDetails$LastModifiedTime' => 'The last modified time.
', 'UserProfileDetails$LastModifiedTime' => 'The last modified time.
', ], ], 'LastUpdateStatus' => [ 'base' => 'A value that indicates whether the update was successful.
', 'refs' => [ 'DescribeFeatureGroupResponse$LastUpdateStatus' => 'A value indicating whether the update made to the feature group was successful.
', 'FeatureGroup$LastUpdateStatus' => 'A value that indicates whether the feature group was updated successfully.
', ], ], 'LastUpdateStatusValue' => [ 'base' => NULL, 'refs' => [ 'LastUpdateStatus$Status' => 'A value that indicates whether the update was made successful.
', ], ], 'LifecycleConfigArns' => [ 'base' => NULL, 'refs' => [ 'JupyterServerAppSettings$LifecycleConfigArns' => ' 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.
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.
A list of properties to add to the action.
', 'CreateArtifactRequest$Properties' => 'A list of properties to add to the artifact.
', 'CreateContextRequest$Properties' => 'A list of properties to add to the context.
', 'DescribeActionResponse$Properties' => 'A list of the action\'s properties.
', 'DescribeArtifactResponse$Properties' => 'A list of the artifact\'s properties.
', 'DescribeContextResponse$Properties' => 'A list of the context\'s properties.
', 'UpdateActionRequest$Properties' => 'The new list of properties. Overwrites the current property list.
', 'UpdateArtifactRequest$Properties' => 'The new list of properties. Overwrites the current property list.
', 'UpdateContextRequest$Properties' => 'The new list of properties. Overwrites the current property list.
', ], ], 'LineageGroupArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'DescribeArtifactResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'DescribeContextResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'DescribeLineageGroupResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'DescribeTrialComponentResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'GetLineageGroupPolicyResponse$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group.
', 'LineageGroupSummary$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group resource.
', 'TrialComponent$LineageGroupArn' => 'The Amazon Resource Name (ARN) of the lineage group resource.
', ], ], 'LineageGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyRequest$LineageGroupName' => 'The name or Amazon Resource Name (ARN) of the lineage group.
', ], ], 'LineageGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsResponse$LineageGroupSummaries' => 'A list of lineage groups and their properties.
', ], ], 'LineageGroupSummary' => [ 'base' => 'Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.
', 'refs' => [ 'LineageGroupSummaries$member' => NULL, ], ], 'LineageType' => [ 'base' => NULL, 'refs' => [ 'QueryLineageTypes$member' => NULL, 'Vertex$LineageType' => 'The type of resource of the lineage entity.
', ], ], 'ListActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsRequest$SortBy' => 'The field by which to sort results. The default is CreationTime.
The column to sort by.
', ], ], 'ListDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansRequest$SortBy' => 'The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.
Use to specify what column to sort by.
', ], ], 'ListEndpointConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsRequest$SortBy' => 'The parameter by which to sort the results.
', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$SortBy' => 'The field to sort results by. The default is CreationTime.
A list of properties to remove.
', 'UpdateArtifactRequest$PropertiesToRemove' => 'A list of properties to remove.
', 'UpdateContextRequest$PropertiesToRemove' => 'A list of properties to remove.
', ], ], 'ListLineageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$MaxResults' => 'The maximum number of results to select.
', 'ListDevicesRequest$MaxResults' => 'Maximum number of results to select.
', 'ListEdgeDeploymentPlansRequest$MaxResults' => 'The maximum number of results to select (50 by default).
', 'ListEdgePackagingJobsRequest$MaxResults' => 'Maximum number of results to select.
', 'ListStageDevicesRequest$MaxResults' => 'The maximum number of requests to select.
', ], ], 'ListModelBiasJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelBiasJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListTagsInput$MaxResults' => 'Maximum number of tags to return.
', ], ], 'ListTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'UpdateTrialComponentRequest$ParametersToRemove' => 'The hyperparameters to remove from the component.
', 'UpdateTrialComponentRequest$InputArtifactsToRemove' => 'The input artifacts to remove from the component.
', 'UpdateTrialComponentRequest$OutputArtifactsToRemove' => 'The output artifacts to remove from the component.
', ], ], 'ListTrialComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesRequest$SortBy' => 'Sort workforces using the workforce name or creation date.
', ], ], 'ListWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsRequest$SortBy' => 'The field to sort results by. The default is CreationTime.
The number of Edge Manager agents.
', 'DeviceStats$ConnectedDeviceCount' => 'The number of devices connected with a heartbeat.
', 'DeviceStats$RegisteredDeviceCount' => 'The number of registered devices.
', 'EdgeModelStat$OfflineDeviceCount' => 'The number of devices that have this model version and do not have a heart beat.
', 'EdgeModelStat$ConnectedDeviceCount' => 'The number of devices that have this model version and have a heart beat.
', 'EdgeModelStat$ActiveDeviceCount' => 'The number of devices that have this model version, a heart beat, and are currently running.
', 'EdgeModelStat$SamplingDeviceCount' => 'The number of devices with this model version and are producing sample data.
', ], ], 'MLFramework' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$MLFramework' => 'The machine learning framework vended in the image version.
', 'DescribeImageVersionResponse$MLFramework' => 'The machine learning framework vended in the image version.
', 'UpdateImageVersionRequest$MLFramework' => 'The machine learning framework vended in the image version.
', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxAutoMLJobRuntimeInSeconds' => '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.
', ], ], 'MaxCandidates' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxCandidates' => 'The maximum number of times a training job is allowed to run.
For text and image classification, as well as time-series forecasting problem types, the supported value is 1. For tabular problem types, the maximum value is 750.
', ], ], 'MaxConcurrentInvocationsPerInstance' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceClientConfig$MaxConcurrentInvocationsPerInstance' => '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.
', ], ], 'MaxConcurrentTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$MaxConcurrentTaskCount' => '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.
', ], ], 'MaxConcurrentTransforms' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$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.
The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.
', 'TransformJob$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 number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
', ], ], 'MaxHumanLabeledObjectCount' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxHumanLabeledObjectCount' => 'The maximum number of objects that can be labeled by human workers.
', ], ], 'MaxNumberOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxNumberOfTests' => 'Defines the maximum number of load tests.
', ], ], 'MaxNumberOfTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxNumberOfTrainingJobs' => 'The maximum number of training jobs that a hyperparameter tuning job can launch.
', ], ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'base' => NULL, 'refs' => [ 'BestObjectiveNotImproving$MaxNumberOfTrainingJobsNotImproving' => '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.
', ], ], 'MaxParallelExecutionSteps' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$MaxParallelExecutionSteps' => 'The max number of steps that can be executed in parallel.
', ], ], 'MaxParallelOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxParallelOfTests' => 'Defines the maximum number of parallel load tests.
', ], ], 'MaxParallelTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxParallelTrainingJobs' => 'The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
', ], ], 'MaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxPayloadInMB' => '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.
The maximum payload size, in MB, used in the transform job.
', 'TransformJob$MaxPayloadInMB' => '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.
The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
', ], ], 'MaxPercentageOfInputDatasetLabeled' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxPercentageOfInputDatasetLabeled' => 'The maximum number of input data objects that should be labeled.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$MaxResults' => 'The maximum number of actions to return in the response. The default value is 10.
', 'ListAlgorithmsInput$MaxResults' => 'The maximum number of algorithms to return in the response.
', 'ListAliasesRequest$MaxResults' => 'The maximum number of aliases to return.
', 'ListAppImageConfigsRequest$MaxResults' => '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.
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.
The maximum number of artifacts to return in the response. The default value is 10.
', 'ListAssociationsRequest$MaxResults' => 'The maximum number of associations to return in the response. The default value is 10.
', 'ListCodeRepositoriesInput$MaxResults' => 'The maximum number of Git repositories to return in the response.
', 'ListCompilationJobsRequest$MaxResults' => 'The maximum number of model compilation jobs to return in the response.
', 'ListContextsRequest$MaxResults' => 'The maximum number of contexts to return in the response. The default value is 10.
', 'ListDataQualityJobDefinitionsRequest$MaxResults' => 'The maximum number of data quality monitoring job definitions to return in the response.
', 'ListDomainsRequest$MaxResults' => '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.
The maximum number of training jobs to return in the response.
', 'ListEndpointsInput$MaxResults' => 'The maximum number of endpoints to return in the response. This value defaults to 10.
', 'ListExperimentsRequest$MaxResults' => 'The maximum number of experiments to return in the response. The default value is 10.
', 'ListFlowDefinitionsRequest$MaxResults' => 'The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The maximum number of hub content versions to list.
', 'ListHubContentsRequest$MaxResults' => 'The maximum amount of hub content to list.
', 'ListHubsRequest$MaxResults' => 'The maximum number of hubs to list.
', 'ListHumanTaskUisRequest$MaxResults' => 'The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The maximum number of tuning jobs to return. The default value is 10.
', 'ListImageVersionsRequest$MaxResults' => 'The maximum number of versions to return in the response. The default value is 10.
', 'ListImagesRequest$MaxResults' => 'The maximum number of images to return in the response. The default value is 10.
', 'ListInferenceExperimentsRequest$MaxResults' => 'The maximum number of results to select.
', 'ListInferenceRecommendationsJobStepsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListInferenceRecommendationsJobsRequest$MaxResults' => 'The maximum number of recommendations to return in the response.
', 'ListLabelingJobsForWorkteamRequest$MaxResults' => 'The maximum number of labeling jobs to return in each page of the response.
', 'ListLabelingJobsRequest$MaxResults' => 'The maximum number of labeling jobs to return in each page of the response.
', 'ListLineageGroupsRequest$MaxResults' => 'The maximum number of endpoints to return in the response. This value defaults to 10.
', 'ListModelBiasJobDefinitionsRequest$MaxResults' => 'The maximum number of model bias jobs to return in the response. The default value is 10.
', 'ListModelCardExportJobsRequest$MaxResults' => 'The maximum number of model card export jobs to list.
', 'ListModelCardVersionsRequest$MaxResults' => 'The maximum number of model card versions to list.
', 'ListModelCardsRequest$MaxResults' => 'The maximum number of model cards to list.
', 'ListModelExplainabilityJobDefinitionsRequest$MaxResults' => 'The maximum number of jobs to return in the response. The default value is 10.
', 'ListModelMetadataRequest$MaxResults' => 'The maximum number of models to return in the response.
', 'ListModelPackageGroupsInput$MaxResults' => 'The maximum number of results to return in the response.
', 'ListModelPackagesInput$MaxResults' => 'The maximum number of model packages to return in the response.
', 'ListModelQualityJobDefinitionsRequest$MaxResults' => 'The maximum number of results to return in a call to ListModelQualityJobDefinitions.
The maximum number of models to return in the response.
', 'ListMonitoringAlertHistoryRequest$MaxResults' => 'The maximum number of results to display. The default is 100.
', 'ListMonitoringAlertsRequest$MaxResults' => 'The maximum number of results to display. The default is 100.
', 'ListMonitoringExecutionsRequest$MaxResults' => 'The maximum number of jobs to return in the response. The default value is 10.
', 'ListMonitoringSchedulesRequest$MaxResults' => 'The maximum number of jobs to return in the response. The default value is 10.
', 'ListNotebookInstanceLifecycleConfigsInput$MaxResults' => 'The maximum number of lifecycle configurations to return in the response.
', 'ListNotebookInstancesInput$MaxResults' => 'The maximum number of notebook instances to return.
', 'ListPipelineExecutionStepsRequest$MaxResults' => 'The maximum number of pipeline execution steps to return in the response.
', 'ListPipelineExecutionsRequest$MaxResults' => 'The maximum number of pipeline executions to return in the response.
', 'ListPipelineParametersForExecutionRequest$MaxResults' => 'The maximum number of parameters to return in the response.
', 'ListPipelinesRequest$MaxResults' => 'The maximum number of pipelines to return in the response.
', 'ListProcessingJobsRequest$MaxResults' => 'The maximum number of processing jobs to return in the response.
', 'ListProjectsInput$MaxResults' => 'The maximum number of projects to return in the response.
', 'ListResourceCatalogsRequest$MaxResults' => ' The maximum number of results returned by ListResourceCatalogs.
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.
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.
The maximum number of work teams to return in each page of the response.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$MaxResults' => 'The maximum number of training jobs to return. The default value is 10.
', 'ListTrainingJobsRequest$MaxResults' => 'The maximum number of training jobs to return in the response.
', 'ListTransformJobsRequest$MaxResults' => 'The maximum number of transform jobs to return in the response. The default value is 10.
The maximum number of components to return in the response. The default value is 10.
', 'ListTrialsRequest$MaxResults' => 'The maximum number of trials to return in the response. The default value is 10.
', 'ListUserProfilesRequest$MaxResults' => '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.
The maximum number of workforces returned in the response.
', 'ListWorkteamsRequest$MaxResults' => 'The maximum number of work teams to return in each page of the response.
', 'SearchRequest$MaxResults' => 'The maximum number of results to return.
', ], ], 'MaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxRuntimeInSeconds' => '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 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.
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.
Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.
The time limit for the total deployment. Exceeding this limit causes a timeout.
', ], ], 'MaximumRetryAttempts' => [ 'base' => NULL, 'refs' => [ 'RetryStrategy$MaximumRetryAttempts' => 'The number of times to retry the job. When the job is retried, it\'s SecondaryStatus is changed to STARTING.
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.
', ], ], 'MemberDefinition' => [ 'base' => 'Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
', 'refs' => [ 'MemberDefinitions$member' => NULL, ], ], 'MemberDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$MemberDefinitions' => '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.
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.
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.
Metadata properties of the tracking entity, trial, or trial component.
', 'refs' => [ 'CreateActionRequest$MetadataProperties' => NULL, 'CreateArtifactRequest$MetadataProperties' => NULL, 'CreateModelPackageInput$MetadataProperties' => NULL, 'CreateTrialComponentRequest$MetadataProperties' => NULL, 'CreateTrialRequest$MetadataProperties' => NULL, 'DescribeActionResponse$MetadataProperties' => NULL, 'DescribeArtifactResponse$MetadataProperties' => NULL, 'DescribeModelPackageOutput$MetadataProperties' => NULL, 'DescribeTrialComponentResponse$MetadataProperties' => NULL, 'DescribeTrialResponse$MetadataProperties' => NULL, 'ModelPackage$MetadataProperties' => 'Metadata properties of the tracking entity, trial, or trial component.
', 'Trial$MetadataProperties' => NULL, 'TrialComponent$MetadataProperties' => NULL, ], ], 'MetadataPropertyValue' => [ 'base' => NULL, 'refs' => [ 'MetadataProperties$CommitId' => 'The commit ID.
', 'MetadataProperties$Repository' => 'The repository.
', 'MetadataProperties$GeneratedBy' => 'The entity this entity was generated by.
', 'MetadataProperties$ProjectId' => 'The project ID.
', ], ], 'MetricData' => [ 'base' => 'The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
', 'refs' => [ 'FinalMetricDataList$member' => NULL, ], ], 'MetricDataList' => [ 'base' => NULL, 'refs' => [ 'CandidateProperties$CandidateMetrics' => 'Information about the candidate metrics for an AutoML job.
', ], ], 'MetricDatum' => [ 'base' => 'Information about the metric for a candidate produced by an AutoML job.
', 'refs' => [ 'MetricDataList$member' => NULL, ], ], 'MetricDefinition' => [ 'base' => '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.
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.
', 'HyperParameterAlgorithmSpecification$MetricDefinitions' => 'An array of MetricDefinition objects that specify the metrics that the algorithm emits.
', 'TrainingSpecification$MetricDefinitions' => 'A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.
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.
', 'HyperParameterTuningJobObjective$MetricName' => 'The name of the metric to use for the objective metric.
', 'MetricData$MetricName' => 'The name of the metric.
', 'MetricDefinition$Name' => 'The name of the metric.
', 'TrialComponentMetricSummary$MetricName' => 'The name of the metric.
', ], ], 'MetricRegex' => [ 'base' => NULL, 'refs' => [ 'MetricDefinition$Regex' => '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.
', ], ], 'MetricSetSource' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$Set' => 'The dataset split from which the AutoML job produced the metric.
', ], ], 'MetricSpecification' => [ 'base' => 'An object containing information about a metric.
', 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$MetricSpecification' => 'An object containing information about a metric.
', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Value' => 'The value of the metric with the best result.
', 'FinalHyperParameterTuningJobObjectiveMetric$Value' => 'The value of the objective metric.
', ], ], 'MetricsSource' => [ 'base' => 'Details about the metrics source.
', 'refs' => [ 'Bias$Report' => 'The bias report for a model
', 'Bias$PreTrainingReport' => 'The pre-training bias report for a model.
', 'Bias$PostTrainingReport' => 'The post-training bias report for a model.
', 'DriftCheckBias$PreTrainingConstraints' => 'The pre-training constraints.
', 'DriftCheckBias$PostTrainingConstraints' => 'The post-training constraints.
', 'DriftCheckExplainability$Constraints' => 'The drift check explainability constraints.
', 'DriftCheckModelDataQuality$Statistics' => 'The drift check model data quality statistics.
', 'DriftCheckModelDataQuality$Constraints' => 'The drift check model data quality constraints.
', 'DriftCheckModelQuality$Statistics' => 'The drift check model quality statistics.
', 'DriftCheckModelQuality$Constraints' => 'The drift check model quality constraints.
', 'Explainability$Report' => 'The explainability report for a model.
', 'ModelDataQuality$Statistics' => 'Data quality statistics for a model.
', 'ModelDataQuality$Constraints' => 'Data quality constraints for a model.
', 'ModelQuality$Statistics' => 'Model quality statistics.
', 'ModelQuality$Constraints' => 'Model quality constraints.
', ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataServiceConfiguration$MinimumInstanceMetadataServiceVersion' => '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 properties of a model as returned by the Search API.
', 'refs' => [ 'ModelDashboardModel$Model' => 'A model displayed in the Model Dashboard.
', ], ], 'ModelApprovalStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelApprovalStatus' => 'The approval status of the model.
', 'CreateModelPackageInput$ModelApprovalStatus' => '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 approval status of the model package.
', 'ListModelPackagesInput$ModelApprovalStatus' => 'A filter that returns only the model packages with the specified approval status.
', 'ModelPackage$ModelApprovalStatus' => '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 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 approval status of the model.
', ], ], 'ModelArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelOutput$ModelArn' => 'The ARN of the model created in SageMaker.
', 'DescribeModelOutput$ModelArn' => 'The Amazon Resource Name (ARN) of the model.
', 'LabelingJobAlgorithmsConfig$InitialActiveLearningModelArn' => '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.
', 'LabelingJobOutput$FinalActiveLearningModelArn' => 'The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.
', 'Model$ModelArn' => 'The Amazon Resource Name (ARN) of the model.
', 'ModelSummary$ModelArn' => 'The Amazon Resource Name (ARN) of the model.
', ], ], 'ModelArtifacts' => [ 'base' => 'Provides information about the location that is configured for storing model artifacts.
Model artifacts are the output that results from training a model, and typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata.
', 'refs' => [ 'DescribeCompilationJobResponse$ModelArtifacts' => 'Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
', 'DescribeTrainingJobResponse$ModelArtifacts' => 'Information about the Amazon S3 location that is configured for storing model artifacts.
', 'TrainingJob$ModelArtifacts' => 'Information about the Amazon S3 location that is configured for storing model artifacts.
', ], ], 'ModelBiasAppSpecification' => [ 'base' => 'Docker container image configuration object for the model bias job.
', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasAppSpecification' => 'Configures the model bias job to run a specified Docker container image.
', 'DescribeModelBiasJobDefinitionResponse$ModelBiasAppSpecification' => 'Configures the model bias job to run a specified Docker container image.
', ], ], 'ModelBiasBaselineConfig' => [ 'base' => 'The configuration for a baseline model bias job.
', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasBaselineConfig' => 'The baseline configuration for a model bias job.
', 'DescribeModelBiasJobDefinitionResponse$ModelBiasBaselineConfig' => 'The baseline configuration for a model bias job.
', ], ], 'ModelBiasJobInput' => [ 'base' => 'Inputs for the model bias job.
', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasJobInput' => 'Inputs for the model bias job.
', 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobInput' => 'Inputs for the model bias job.
', ], ], 'ModelCacheSetting' => [ 'base' => NULL, 'refs' => [ 'MultiModelConfig$ModelCacheSetting' => '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.
An Amazon SageMaker Model Card.
', 'refs' => [ 'SearchRecord$ModelCard' => 'An Amazon SageMaker Model Card that documents details about a machine learning model.
', ], ], 'ModelCardArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardResponse$ModelCardArn' => 'The Amazon Resource Name (ARN) of the successfully created model card.
', 'DescribeModelCardResponse$ModelCardArn' => 'The Amazon Resource Name (ARN) of the model card.
', 'ModelCard$ModelCardArn' => 'The Amazon Resource Name (ARN) of the model card.
', 'ModelCardSummary$ModelCardArn' => 'The Amazon Resource Name (ARN) of the model card.
', 'ModelCardVersionSummary$ModelCardArn' => 'The Amazon Resource Name (ARN) of the model card.
', 'ModelDashboardModelCard$ModelCardArn' => 'The Amazon Resource Name (ARN) for a model card.
', 'UpdateModelCardResponse$ModelCardArn' => 'The Amazon Resource Name (ARN) of the updated model card.
', ], ], 'ModelCardContent' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$Content' => 'The content of the model card. Content must be in model card JSON schema and provided as a string.
', 'DescribeModelCardResponse$Content' => 'The content of the model card.
', 'ModelCard$Content' => 'The content of the model card. Content uses the model card JSON schema and provided as a string.
', 'UpdateModelCardRequest$Content' => '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.
', ], ], 'ModelCardExportArtifacts' => [ 'base' => 'The artifacts of the model card export job.
', 'refs' => [ 'DescribeModelCardExportJobResponse$ExportArtifacts' => 'The exported model card artifacts.
', ], ], 'ModelCardExportJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobResponse$ModelCardExportJobArn' => 'The Amazon Resource Name (ARN) of the model card export job.
', 'DescribeModelCardExportJobRequest$ModelCardExportJobArn' => 'The Amazon Resource Name (ARN) of the model card export job to describe.
', 'DescribeModelCardExportJobResponse$ModelCardExportJobArn' => 'The Amazon Resource Name (ARN) of the model card export job.
', 'ModelCardExportJobSummary$ModelCardExportJobArn' => 'The Amazon Resource Name (ARN) of the model card export job.
', ], ], 'ModelCardExportJobSortBy' => [ 'base' => 'Attribute by which to sort returned export jobs.', 'refs' => [ 'ListModelCardExportJobsRequest$SortBy' => 'Sort model card export jobs by either name or creation time. Sorts by creation time by default.
', ], ], 'ModelCardExportJobSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsRequest$SortOrder' => 'Sort model card export jobs by ascending or descending order.
', ], ], 'ModelCardExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardExportJobResponse$Status' => '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.
Only list model card export jobs with the specified status.
', 'ModelCardExportJobSummary$Status' => 'The completion status of the model card export job.
', ], ], 'ModelCardExportJobSummary' => [ 'base' => 'The summary of the Amazon SageMaker Model Card export job.
', 'refs' => [ 'ModelCardExportJobSummaryList$member' => NULL, ], ], 'ModelCardExportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsResponse$ModelCardExportJobSummaries' => 'The summaries of the listed model card export jobs.
', ], ], 'ModelCardExportOutputConfig' => [ 'base' => 'Configure the export output details for an Amazon SageMaker Model Card.
', 'refs' => [ 'CreateModelCardExportJobRequest$OutputConfig' => 'The model card output configuration that specifies the Amazon S3 path for exporting.
', 'DescribeModelCardExportJobResponse$OutputConfig' => 'The export output details for the model card.
', ], ], 'ModelCardProcessingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardResponse$ModelCardProcessingStatus' => '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.
Configure the security settings to protect model card data.
', 'refs' => [ 'CreateModelCardRequest$SecurityConfig' => 'An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
', 'DescribeModelCardResponse$SecurityConfig' => 'The security configuration used to protect model card content.
', 'ModelCard$SecurityConfig' => 'The security configuration used to protect model card data.
', 'ModelDashboardModelCard$SecurityConfig' => 'The KMS Key ID (KMSKeyId) for encryption of model card information.
Sort model cards by either name or creation time. Sorts by creation time by default.
', ], ], 'ModelCardSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortOrder' => 'Sort model card versions by ascending or descending order.
', 'ListModelCardsRequest$SortOrder' => 'Sort model cards by ascending or descending order.
', ], ], 'ModelCardStatus' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$ModelCardStatus' => '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 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.
Only list model card versions with the specified approval status.
', 'ListModelCardsRequest$ModelCardStatus' => 'Only list model cards with the specified approval status.
', 'ModelCard$ModelCardStatus' => '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 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.
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 card status.
', 'UpdateModelCardRequest$ModelCardStatus' => '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.
A summary of the model card.
', 'refs' => [ 'ModelCardSummaryList$member' => NULL, ], ], 'ModelCardSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsResponse$ModelCardSummaries' => 'The summaries of the listed model cards.
', ], ], 'ModelCardVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortBy' => 'Sort listed model card versions by version. Sorts by version by default.
', ], ], 'ModelCardVersionSummary' => [ 'base' => 'A summary of a specific version of the model card.
', 'refs' => [ 'ModelCardVersionSummaryList$member' => NULL, ], ], 'ModelCardVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsResponse$ModelCardVersionSummaryList' => 'The summaries of the listed versions of the model card.
', ], ], 'ModelClientConfig' => [ 'base' => 'Configures the timeout and maximum number of retries for processing a transform job invocation.
', 'refs' => [ 'CreateTransformJobRequest$ModelClientConfig' => 'Configures the timeout and maximum number of retries for processing a transform job invocation.
', 'DescribeTransformJobResponse$ModelClientConfig' => 'The timeout and maximum number of retries for processing a transform job invocation.
', 'TransformJob$ModelClientConfig' => NULL, ], ], 'ModelCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$CompressionType' => 'Specifies 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.
Defines the model configuration. Includes the specification name and environment parameters.
', 'refs' => [ 'InferenceRecommendation$ModelConfiguration' => 'Defines the model configuration.
', 'RecommendationJobInferenceBenchmark$ModelConfiguration' => NULL, ], ], 'ModelDashboardEndpoint' => [ 'base' => 'An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.
', 'refs' => [ 'ModelDashboardEndpoints$member' => NULL, ], ], 'ModelDashboardEndpoints' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$Endpoints' => 'The endpoints that host a model.
', ], ], 'ModelDashboardIndicatorAction' => [ 'base' => 'An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.
An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.
A model displayed in the Amazon SageMaker Model Dashboard.
', 'refs' => [ 'SearchRecord$Model' => NULL, ], ], 'ModelDashboardModelCard' => [ 'base' => 'The model card for a model displayed in the Amazon SageMaker Model Dashboard.
', 'refs' => [ 'ModelDashboardModel$ModelCard' => 'The model card for a model.
', ], ], 'ModelDashboardMonitoringSchedule' => [ 'base' => 'A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.
', 'refs' => [ 'ModelDashboardMonitoringSchedules$member' => NULL, ], ], 'ModelDashboardMonitoringSchedules' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$MonitoringSchedules' => 'The monitoring schedules for a model.
', ], ], 'ModelDataQuality' => [ 'base' => 'Data quality constraints and statistics for a model.
', 'refs' => [ 'ModelMetrics$ModelDataQuality' => 'Metrics that measure the quality of the input data for a model.
', ], ], 'ModelDataSource' => [ 'base' => 'Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.
', 'refs' => [ 'ContainerDefinition$ModelDataSource' => '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.
Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
', 'refs' => [ 'CreateAutoMLJobRequest$ModelDeployConfig' => 'Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
', 'CreateAutoMLJobV2Request$ModelDeployConfig' => 'Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
', 'DescribeAutoMLJobResponse$ModelDeployConfig' => 'Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
', 'DescribeAutoMLJobV2Response$ModelDeployConfig' => 'Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
', ], ], 'ModelDeployResult' => [ 'base' => 'Provides information about the endpoint of the model deployment.
', 'refs' => [ 'DescribeAutoMLJobResponse$ModelDeployResult' => 'Provides information about endpoint for the model deployment.
', 'DescribeAutoMLJobV2Response$ModelDeployResult' => 'Provides information about endpoint for the model deployment.
', ], ], 'ModelDigests' => [ 'base' => 'Provides information to verify the integrity of stored model artifacts.
', 'refs' => [ 'DescribeCompilationJobResponse$ModelDigests' => 'Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
', ], ], 'ModelExplainabilityAppSpecification' => [ 'base' => 'Docker container image configuration object for the model explainability job.
', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityAppSpecification' => 'Configures the model explainability job to run a specified Docker container image.
', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityAppSpecification' => 'Configures the model explainability job to run a specified Docker container image.
', ], ], 'ModelExplainabilityBaselineConfig' => [ 'base' => 'The configuration for a baseline model explainability job.
', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityBaselineConfig' => 'The baseline configuration for a model explainability job.
', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityBaselineConfig' => 'The baseline configuration for a model explainability job.
', ], ], 'ModelExplainabilityJobInput' => [ 'base' => 'Inputs for the model explainability job.
', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobInput' => 'Inputs for the model explainability job.
', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobInput' => 'Inputs for the model explainability job.
', ], ], 'ModelInfrastructureConfig' => [ 'base' => 'The configuration for the infrastructure that the model will be deployed to.
', 'refs' => [ 'ModelVariantConfig$InfrastructureConfig' => 'The configuration for the infrastructure that the model will be deployed to.
', 'ModelVariantConfigSummary$InfrastructureConfig' => 'The configuration of the infrastructure that the model has been deployed to.
', ], ], 'ModelInfrastructureType' => [ 'base' => NULL, 'refs' => [ 'ModelInfrastructureConfig$InfrastructureType' => 'The inference option to which to deploy your model. Possible values are the following:
RealTime: Deploy to real-time inference.
Input object for the model.
', 'refs' => [ 'ModelPackageContainerDefinition$ModelInput' => 'A structure with Model Input details.
', ], ], 'ModelInsightsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$ModelInsights' => 'The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.
', ], ], 'ModelLatencyThreshold' => [ 'base' => 'The model latency threshold.
', 'refs' => [ 'ModelLatencyThresholds$member' => NULL, ], ], 'ModelLatencyThresholds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$ModelLatencyThresholds' => '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.
', ], ], 'ModelMetadataFilter' => [ 'base' => 'Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).
', 'refs' => [ 'ModelMetadataFilters$member' => NULL, ], ], 'ModelMetadataFilterType' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataFilter$Name' => 'The name of the of the model to filter by.
', ], ], 'ModelMetadataFilters' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataSearchExpression$Filters' => 'A list of filter objects.
', ], ], 'ModelMetadataSearchExpression' => [ 'base' => '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
', 'refs' => [ 'ListModelMetadataRequest$SearchExpression' => '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.
', ], ], 'ModelMetadataSummaries' => [ 'base' => NULL, 'refs' => [ 'ListModelMetadataResponse$ModelMetadataSummaries' => 'A structure that holds model metadata.
', ], ], 'ModelMetadataSummary' => [ 'base' => 'A summary of the model metadata.
', 'refs' => [ 'ModelMetadataSummaries$member' => NULL, ], ], 'ModelMetrics' => [ 'base' => 'Contains metrics captured from a model.
', 'refs' => [ 'CreateModelPackageInput$ModelMetrics' => 'A structure that contains model metrics reports.
', 'DescribeModelPackageOutput$ModelMetrics' => 'Metrics for the model.
', 'ModelPackage$ModelMetrics' => 'Metrics for the model.
', ], ], 'ModelName' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$ModelName' => 'The name of the new model.
', 'CreateTransformJobRequest$ModelName' => '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 name of the model to delete.
', 'DescribeModelInput$ModelName' => 'The name of the model.
', 'DescribeModelOutput$ModelName' => 'Name of the SageMaker model.
', 'DescribeTransformJobResponse$ModelName' => 'The name of the model used in the transform job.
', 'InferenceRecommendationsJob$ModelName' => 'The name of the created model.
', 'ListInferenceRecommendationsJobsRequest$ModelNameEquals' => 'A filter that returns only jobs that were created for this model.
', 'Model$ModelName' => 'The name of the model.
', 'ModelSummary$ModelName' => 'The name of the model that you want a summary for.
', 'ModelVariantConfig$ModelName' => 'The name of the Amazon SageMaker Model entity.
', 'ModelVariantConfigSummary$ModelName' => 'The name of the Amazon SageMaker Model entity.
', 'ProductionVariant$ModelName' => 'The name of the model that you want to host. This is the name that you specified when creating the model.
', 'RecommendationJobInputConfig$ModelName' => 'The name of the created model.
', 'TransformJob$ModelName' => 'The name of the model associated with the transform job.
', ], ], 'ModelNameContains' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$NameContains' => 'A string in the model name. This filter returns only models whose name contains the specified string.
', ], ], 'ModelPackage' => [ 'base' => 'A versioned model that can be deployed for SageMaker inference.
', 'refs' => [ 'SearchRecord$ModelPackage' => NULL, ], ], 'ModelPackageArn' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageErrorMap$key' => NULL, 'BatchDescribeModelPackageSummary$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'CreateCompilationJobRequest$ModelPackageVersionArn' => '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.
The Amazon Resource Name (ARN) of the new model package.
', 'DescribeCompilationJobResponse$ModelPackageVersionArn' => 'The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.
', 'DescribeModelPackageOutput$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'InferenceRecommendationsJob$ModelPackageVersionArn' => 'The Amazon Resource Name (ARN) of a versioned model package.
', 'ListInferenceRecommendationsJobsRequest$ModelPackageVersionArnEquals' => 'A filter that returns only jobs that were created for this versioned model package.
', 'ModelPackage$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'ModelPackageArnList$member' => NULL, 'ModelPackageSummaries$key' => NULL, 'ModelPackageSummary$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'RecommendationJobInputConfig$ModelPackageVersionArn' => 'The Amazon Resource Name (ARN) of a versioned model package.
', 'UpdateModelPackageInput$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model package.
', 'UpdateModelPackageOutput$ModelPackageArn' => 'The Amazon Resource Name (ARN) of the model.
', ], ], 'ModelPackageArnList' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageInput$ModelPackageArnList' => 'The list of Amazon Resource Name (ARN) of the model package groups.
', ], ], 'ModelPackageContainerDefinition' => [ 'base' => 'Describes the Docker container for the model package.
', 'refs' => [ 'ModelPackageContainerDefinitionList$member' => NULL, ], ], 'ModelPackageContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Containers' => 'The Amazon ECR registry path of the Docker image that contains the inference code.
', 'InferenceSpecification$Containers' => 'The Amazon ECR registry path of the Docker image that contains the inference code.
', ], ], 'ModelPackageFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$FrameworkVersion' => 'The framework version of the Model Package Container Image.
', ], ], 'ModelPackageGroup' => [ 'base' => 'A group of versioned models in the model registry.
', 'refs' => [ 'SearchRecord$ModelPackageGroup' => NULL, ], ], 'ModelPackageGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageGroupOutput$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model group.
', 'DescribeModelPackageGroupOutput$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model group.
', 'ModelPackageGroup$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model group.
', 'ModelPackageGroupSummary$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model group.
', 'PutModelPackageGroupPolicyOutput$ModelPackageGroupArn' => 'The Amazon Resource Name (ARN) of the model package group.
', ], ], 'ModelPackageGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsInput$SortBy' => 'The field to sort results by. The default is CreationTime.
The status of the model group.
', 'ModelPackageGroup$ModelPackageGroupStatus' => '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.
The status of the model group.
', ], ], 'ModelPackageGroupSummary' => [ 'base' => 'Summary information about a model group.
', 'refs' => [ 'ModelPackageGroupSummaryList$member' => NULL, ], ], 'ModelPackageGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsOutput$ModelPackageGroupSummaryList' => 'A list of summaries of the model groups in your Amazon Web Services account.
', ], ], 'ModelPackageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
The status of the mortgage package.
', 'DescribeModelPackageOutput$ModelPackageStatus' => 'The current status of the model package.
', 'ModelPackage$ModelPackageStatus' => '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.
The overall status of the model package.
', ], ], 'ModelPackageStatusDetails' => [ 'base' => 'Specifies the validation and image scan statuses of the model package.
', 'refs' => [ 'DescribeModelPackageOutput$ModelPackageStatusDetails' => 'Details about the current status of the model package.
', 'ModelPackage$ModelPackageStatusDetails' => 'Specifies the validation and image scan statuses of the model package.
', ], ], 'ModelPackageStatusItem' => [ 'base' => 'Represents the overall status of a model package.
', 'refs' => [ 'ModelPackageStatusItemList$member' => NULL, ], ], 'ModelPackageStatusItemList' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusDetails$ValidationStatuses' => 'The validation status of the model package.
', 'ModelPackageStatusDetails$ImageScanStatuses' => 'The status of the scan of the Docker image container for the model package.
', ], ], 'ModelPackageSummaries' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$ModelPackageSummaries' => 'The summaries for the model package versions
', ], ], 'ModelPackageSummary' => [ 'base' => 'Provides summary information about a model package.
', 'refs' => [ 'ModelPackageSummaryList$member' => NULL, ], ], 'ModelPackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesOutput$ModelPackageSummaryList' => 'An array of ModelPackageSummary objects, each of which lists a model package.
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.
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.
', 'refs' => [ 'ModelPackageValidationProfiles$member' => NULL, ], ], 'ModelPackageValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'ModelPackageValidationSpecification$ValidationProfiles' => 'An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.
Specifies batch transform jobs that SageMaker runs to validate your model package.
', 'refs' => [ 'CreateModelPackageInput$ValidationSpecification' => 'Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.
', 'DescribeModelPackageOutput$ValidationSpecification' => 'Configurations for one or more transform jobs that SageMaker runs to test the model package.
', 'ModelPackage$ValidationSpecification' => 'Specifies batch transform jobs that SageMaker runs to validate your model package.
', ], ], 'ModelPackageVersion' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageVersion' => 'The version number of a versioned model.
', 'DescribeModelPackageOutput$ModelPackageVersion' => 'The version of the model package.
', 'ModelPackage$ModelPackageVersion' => 'The version number of a versioned model.
', 'ModelPackageSummary$ModelPackageVersion' => 'If the model package is a versioned model, the version of the model.
', ], ], 'ModelQuality' => [ 'base' => 'Model quality statistics and constraints.
', 'refs' => [ 'ModelMetrics$ModelQuality' => 'Metrics that measure the quality of a model.
', ], ], 'ModelQualityAppSpecification' => [ 'base' => 'Container image configuration object for the monitoring job.
', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityAppSpecification' => 'The container that runs the monitoring job.
', 'DescribeModelQualityJobDefinitionResponse$ModelQualityAppSpecification' => 'Configures the model quality job to run a specified Docker container image.
', ], ], 'ModelQualityBaselineConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityBaselineConfig' => 'Specifies the constraints and baselines for the monitoring job.
', 'DescribeModelQualityJobDefinitionResponse$ModelQualityBaselineConfig' => 'The baseline configuration for a model quality job.
', ], ], 'ModelQualityJobInput' => [ 'base' => 'The input for the model quality monitoring job. Currently endponts are supported for input for model quality monitoring jobs.
', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityJobInput' => 'A list of the inputs that are monitored. Currently endpoints are supported.
', 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobInput' => 'Inputs for the model quality job.
', ], ], 'ModelRegisterSettings' => [ 'base' => 'The model registry settings for the SageMaker Canvas application.
', 'refs' => [ 'CanvasAppSettings$ModelRegisterSettings' => 'The model registry settings for the SageMaker Canvas application.
', ], ], 'ModelSetupTime' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$ModelSetupTime' => '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.
Sorts the list of results. The default is CreationTime.
Metadata for Model steps.
', 'refs' => [ 'PipelineExecutionStepMetadata$Model' => 'The Amazon Resource Name (ARN) of the model that was created by this step execution.
', ], ], 'ModelSummary' => [ 'base' => 'Provides summary information about a model.
', 'refs' => [ 'ModelSummaryList$member' => NULL, ], ], 'ModelSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelsOutput$Models' => 'An array of ModelSummary objects, each of which lists a model.
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
Contains information about the deployment options of a model.
', 'refs' => [ 'ModelVariantConfigList$member' => NULL, ], ], 'ModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$ModelVariants' => ' 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.
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.
An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.
Summary of the deployment configuration of a model.
', 'refs' => [ 'ModelVariantConfigSummaryList$member' => NULL, ], ], 'ModelVariantConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$ModelVariants' => ' 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.
The name of the variant.
', 'ModelVariantConfigSummary$VariantName' => 'The name of the variant.
', 'ShadowModeConfig$SourceModelVariantName' => 'The name of the production variant, which takes all the inference requests.
', 'ShadowModelVariantConfig$ShadowModelVariantName' => 'The name of the shadow variant.
', ], ], 'ModelVariantStatus' => [ 'base' => NULL, 'refs' => [ 'ModelVariantConfigSummary$Status' => '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.
A list of alert actions taken in response to an alert going into InAlert status.
A list of alert actions taken in response to an alert going into InAlert status.
An alert history for a model monitoring schedule.
', ], ], 'MonitoringAlertHistorySortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$SortBy' => 'The field used to sort results. The default is CreationTime.
Provides summary information of an alert\'s history.
', 'refs' => [ 'MonitoringAlertHistoryList$member' => NULL, ], ], 'MonitoringAlertName' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$MonitoringAlertName' => 'The name of a monitoring alert.
', 'MonitoringAlertHistorySummary$MonitoringAlertName' => 'The name of a monitoring alert.
', 'MonitoringAlertSummary$MonitoringAlertName' => 'The name of a monitoring alert.
', 'UpdateMonitoringAlertRequest$MonitoringAlertName' => 'The name of a monitoring alert.
', 'UpdateMonitoringAlertResponse$MonitoringAlertName' => 'The name of a monitoring alert.
', ], ], 'MonitoringAlertStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$StatusEquals' => 'A filter that retrieves only alerts with a specific status.
', 'MonitoringAlertHistorySummary$AlertStatus' => 'The current alert status of an alert.
', 'MonitoringAlertSummary$AlertStatus' => 'The current status of an alert.
', ], ], 'MonitoringAlertSummary' => [ 'base' => 'Provides summary information about a monitor alert.
', 'refs' => [ 'MonitoringAlertSummaryList$member' => NULL, ], ], 'MonitoringAlertSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertsResponse$MonitoringAlertSummaries' => 'A JSON array where each element is a summary for a monitoring alert.
', 'ModelDashboardMonitoringSchedule$MonitoringAlertSummaries' => 'A JSON array where each element is a summary for a monitoring alert.
', ], ], 'MonitoringAppSpecification' => [ 'base' => 'Container image configuration object for the monitoring job.
', 'refs' => [ 'MonitoringJobDefinition$MonitoringAppSpecification' => 'Configures the monitoring job to run a specified Docker container image.
', ], ], 'MonitoringBaselineConfig' => [ 'base' => '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.
', 'refs' => [ 'MonitoringJobDefinition$BaselineConfig' => 'Baseline configuration used to validate that the data conforms to the specified constraints and statistics
', ], ], 'MonitoringClusterConfig' => [ 'base' => 'Configuration for the cluster used to run model monitoring jobs.
', 'refs' => [ 'MonitoringResources$ClusterConfig' => 'The configuration for the cluster resources used to run the processing job.
', ], ], 'MonitoringConstraintsResource' => [ 'base' => 'The constraints resource for a monitoring job.
', 'refs' => [ 'DataQualityBaselineConfig$ConstraintsResource' => NULL, 'ModelBiasBaselineConfig$ConstraintsResource' => NULL, 'ModelExplainabilityBaselineConfig$ConstraintsResource' => NULL, 'ModelQualityBaselineConfig$ConstraintsResource' => NULL, 'MonitoringBaselineConfig$ConstraintsResource' => 'The baseline constraint file in Amazon S3 that the current monitoring job should validated against.
', ], ], 'MonitoringContainerArguments' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$ContainerArguments' => 'The arguments to send to the container that the monitoring job runs.
', 'ModelQualityAppSpecification$ContainerArguments' => 'An array of arguments for the container used to run the monitoring job.
', 'MonitoringAppSpecification$ContainerArguments' => 'An array of arguments for the container used to run the monitoring job.
', ], ], 'MonitoringCsvDatasetFormat' => [ 'base' => 'Represents the CSV dataset format used when running a monitoring job.
', 'refs' => [ 'MonitoringDatasetFormat$Csv' => 'The CSV dataset used in the monitoring job.
', ], ], 'MonitoringDatapointsToAlert' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$DatapointsToAlert' => 'Within EvaluationPeriod, how many execution failures will raise an alert.
Within EvaluationPeriod, how many execution failures will raise an alert.
Represents the dataset format used when running a monitoring job.
', 'refs' => [ 'BatchTransformInput$DatasetFormat' => 'The dataset format for your batch transform job.
', ], ], 'MonitoringEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$Environment' => 'Sets the environment variables in the container that the monitoring job runs.
', 'ModelBiasAppSpecification$Environment' => 'Sets the environment variables in the Docker container.
', 'ModelExplainabilityAppSpecification$Environment' => 'Sets the environment variables in the Docker container.
', 'ModelQualityAppSpecification$Environment' => 'Sets the environment variables in the container that the monitoring job runs.
', 'MonitoringJobDefinition$Environment' => 'Sets the environment variables in the Docker container.
', ], ], 'MonitoringEvaluationPeriod' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$EvaluationPeriod' => 'The number of most recent monitoring executions to consider when evaluating alert status.
', 'UpdateMonitoringAlertRequest$EvaluationPeriod' => 'The number of most recent monitoring executions to consider when evaluating alert status.
', ], ], 'MonitoringExecutionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$SortBy' => 'Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.
Summary of information about the last monitoring job to run.
', 'refs' => [ 'DescribeMonitoringScheduleResponse$LastMonitoringExecutionSummary' => 'Describes metadata on the last execution to run, if there was one.
', 'ModelDashboardMonitoringSchedule$LastMonitoringExecutionSummary' => NULL, 'MonitoringExecutionSummaryList$member' => NULL, 'MonitoringSchedule$LastMonitoringExecutionSummary' => NULL, ], ], 'MonitoringExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsResponse$MonitoringExecutionSummaries' => 'A JSON array in which each element is a summary for a monitoring execution.
', ], ], 'MonitoringGroundTruthS3Input' => [ 'base' => 'The ground truth labels for the dataset used for the monitoring job.
', 'refs' => [ 'ModelBiasJobInput$GroundTruthS3Input' => 'Location of ground truth labels to use in model bias job.
', 'ModelQualityJobInput$GroundTruthS3Input' => 'The ground truth label provided for the model.
', ], ], 'MonitoringInput' => [ 'base' => 'The inputs for a monitoring job.
', 'refs' => [ 'MonitoringInputs$member' => NULL, ], ], 'MonitoringInputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringJobDefinition$MonitoringInputs' => 'The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
', ], ], 'MonitoringJobDefinition' => [ 'base' => 'Defines the monitoring job.
', 'refs' => [ 'MonitoringScheduleConfig$MonitoringJobDefinition' => 'Defines the monitoring job.
', ], ], 'MonitoringJobDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the job definition.
', 'CreateModelBiasJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model bias job.
', 'CreateModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model explainability job.
', 'CreateModelQualityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model quality monitoring job.
', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the data quality monitoring job definition.
', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model bias job.
', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model explainability job.
', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionArn' => 'The Amazon Resource Name (ARN) of the model quality job.
', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionArn' => 'The Amazon Resource Name (ARN) of the monitoring job.
', ], ], 'MonitoringJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobDefinitionName' => 'The name for the monitoring job definition.
', 'CreateModelBiasJobDefinitionRequest$JobDefinitionName' => 'The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'CreateModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '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.
', 'CreateModelQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the monitoring job definition.
', 'DeleteDataQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the data quality monitoring job definition to delete.
', 'DeleteModelBiasJobDefinitionRequest$JobDefinitionName' => 'The name of the model bias job definition to delete.
', 'DeleteModelExplainabilityJobDefinitionRequest$JobDefinitionName' => 'The name of the model explainability job definition to delete.
', 'DeleteModelQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the model quality monitoring job definition to delete.
', 'DescribeDataQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the data quality monitoring job definition to describe.
', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionName' => 'The name of the data quality monitoring job definition.
', 'DescribeModelBiasJobDefinitionRequest$JobDefinitionName' => 'The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionName' => 'The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '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.
', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionName' => 'The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeModelQualityJobDefinitionRequest$JobDefinitionName' => 'The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionName' => 'The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'ListMonitoringExecutionsRequest$MonitoringJobDefinitionName' => 'Gets a list of the monitoring job runs of the specified monitoring job definitions.
', 'ListMonitoringSchedulesRequest$MonitoringJobDefinitionName' => 'Gets a list of the monitoring schedules for the specified monitoring job definition.
', 'MonitoringExecutionSummary$MonitoringJobDefinitionName' => 'The name of the monitoring job.
', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionName' => 'The name of the monitoring job.
', 'MonitoringScheduleConfig$MonitoringJobDefinitionName' => 'The name of the monitoring job definition to schedule.
', 'MonitoringScheduleSummary$MonitoringJobDefinitionName' => 'The name of the monitoring job definition that the schedule is for.
', ], ], 'MonitoringJobDefinitionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsRequest$SortBy' => 'The field to sort results by. The default is CreationTime.
Whether to sort results by the Name or CreationTime field. The default is CreationTime.
Whether to sort results by the Name or CreationTime field. The default is CreationTime.
The field to sort results by. The default is CreationTime.
Summary information about a monitoring job.
', 'refs' => [ 'MonitoringJobDefinitionSummaryList$member' => NULL, ], ], 'MonitoringJobDefinitionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsResponse$JobDefinitionSummaries' => 'A list of data quality monitoring job definitions.
', 'ListModelBiasJobDefinitionsResponse$JobDefinitionSummaries' => 'A JSON array in which each element is a summary for a model bias jobs.
', 'ListModelExplainabilityJobDefinitionsResponse$JobDefinitionSummaries' => 'A JSON array in which each element is a summary for a explainability bias jobs.
', 'ListModelQualityJobDefinitionsResponse$JobDefinitionSummaries' => 'A list of summaries of model quality monitoring job definitions.
', ], ], 'MonitoringJsonDatasetFormat' => [ 'base' => 'Represents the JSON dataset format used when running a monitoring job.
', 'refs' => [ 'MonitoringDatasetFormat$Json' => 'The JSON dataset used in the monitoring job
', ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'MonitoringStoppingCondition$MaxRuntimeInSeconds' => '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.
The networking configuration for the monitoring job.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$NetworkConfig' => 'Specifies networking configuration for the monitoring job.
', 'CreateModelBiasJobDefinitionRequest$NetworkConfig' => 'Networking options for a model bias job.
', 'CreateModelExplainabilityJobDefinitionRequest$NetworkConfig' => 'Networking options for a model explainability job.
', 'CreateModelQualityJobDefinitionRequest$NetworkConfig' => 'Specifies the network configuration for the monitoring job.
', 'DescribeDataQualityJobDefinitionResponse$NetworkConfig' => 'The networking configuration for the data quality monitoring job.
', 'DescribeModelBiasJobDefinitionResponse$NetworkConfig' => 'Networking options for a model bias job.
', 'DescribeModelExplainabilityJobDefinitionResponse$NetworkConfig' => 'Networking options for a model explainability job.
', 'DescribeModelQualityJobDefinitionResponse$NetworkConfig' => 'Networking options for a model quality job.
', ], ], 'MonitoringOutput' => [ 'base' => 'The output object for a monitoring job.
', 'refs' => [ 'MonitoringOutputs$member' => NULL, ], ], 'MonitoringOutputConfig' => [ 'base' => 'The output configuration for monitoring jobs.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobOutputConfig' => NULL, 'CreateModelBiasJobDefinitionRequest$ModelBiasJobOutputConfig' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobOutputConfig' => NULL, 'CreateModelQualityJobDefinitionRequest$ModelQualityJobOutputConfig' => NULL, 'DescribeDataQualityJobDefinitionResponse$DataQualityJobOutputConfig' => NULL, 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobOutputConfig' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobOutputConfig' => NULL, 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobOutputConfig' => NULL, 'MonitoringJobDefinition$MonitoringOutputConfig' => 'The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
', ], ], 'MonitoringOutputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringOutputConfig$MonitoringOutputs' => 'Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.
', ], ], 'MonitoringParquetDatasetFormat' => [ 'base' => 'Represents the Parquet dataset format used when running a monitoring job.
', 'refs' => [ 'MonitoringDatasetFormat$Parquet' => 'The Parquet dataset used in the monitoring job
', ], ], 'MonitoringProblemType' => [ 'base' => NULL, 'refs' => [ 'ModelQualityAppSpecification$ProblemType' => 'The machine learning problem type of the model that the monitoring job monitors.
', ], ], 'MonitoringResources' => [ 'base' => 'Identifies the resources to deploy for a monitoring job.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobResources' => NULL, 'CreateModelBiasJobDefinitionRequest$JobResources' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$JobResources' => NULL, 'CreateModelQualityJobDefinitionRequest$JobResources' => NULL, 'DescribeDataQualityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelBiasJobDefinitionResponse$JobResources' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelQualityJobDefinitionResponse$JobResources' => NULL, 'MonitoringJobDefinition$MonitoringResources' => '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.
', ], ], 'MonitoringS3Output' => [ 'base' => 'Information about where and how you want to store the results of a monitoring job.
', 'refs' => [ 'MonitoringOutput$S3Output' => 'The Amazon S3 storage location where the results of a monitoring job are saved.
', ], ], 'MonitoringS3Uri' => [ 'base' => NULL, 'refs' => [ 'MonitoringGroundTruthS3Input$S3Uri' => 'The address of the Amazon S3 location of the ground truth labels.
', 'MonitoringS3Output$S3Uri' => 'A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
', ], ], 'MonitoringSchedule' => [ 'base' => 'A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.
', 'refs' => [ 'MonitoringScheduleList$member' => NULL, ], ], 'MonitoringScheduleArn' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleResponse$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'DescribeMonitoringScheduleResponse$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'DescribeProcessingJobResponse$MonitoringScheduleArn' => 'The ARN of a monitoring schedule for an endpoint associated with this processing job.
', 'ModelDashboardMonitoringSchedule$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of a monitoring schedule.
', 'MonitoringSchedule$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'MonitoringScheduleSummary$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'ProcessingJob$MonitoringScheduleArn' => 'The ARN of a monitoring schedule for an endpoint associated with this processing job.
', 'UpdateMonitoringAlertResponse$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', 'UpdateMonitoringScheduleResponse$MonitoringScheduleArn' => 'The Amazon Resource Name (ARN) of the monitoring schedule.
', ], ], 'MonitoringScheduleConfig' => [ 'base' => 'Configures the monitoring schedule and defines the monitoring job.
', 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleConfig' => 'The configuration object that specifies the monitoring schedule and defines the monitoring job.
', 'DescribeMonitoringScheduleResponse$MonitoringScheduleConfig' => 'The configuration object that specifies the monitoring schedule and defines the monitoring job.
', 'ModelDashboardMonitoringSchedule$MonitoringScheduleConfig' => NULL, 'MonitoringSchedule$MonitoringScheduleConfig' => NULL, 'UpdateMonitoringScheduleRequest$MonitoringScheduleConfig' => 'The configuration object that specifies the monitoring schedule and defines the monitoring job.
', ], ], 'MonitoringScheduleList' => [ 'base' => NULL, 'refs' => [ 'Endpoint$MonitoringSchedules' => 'A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.
', ], ], 'MonitoringScheduleName' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
', 'DeleteMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the monitoring schedule to delete.
', 'DescribeMonitoringScheduleRequest$MonitoringScheduleName' => 'Name of a previously created monitoring schedule.
', 'DescribeMonitoringScheduleResponse$MonitoringScheduleName' => 'Name of the monitoring schedule.
', 'ListMonitoringAlertHistoryRequest$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'ListMonitoringAlertsRequest$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'ListMonitoringExecutionsRequest$MonitoringScheduleName' => 'Name of a specific schedule to fetch jobs for.
', 'ModelDashboardMonitoringSchedule$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'MonitoringAlertHistorySummary$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'MonitoringExecutionSummary$MonitoringScheduleName' => 'The name of the monitoring schedule.
', 'MonitoringSchedule$MonitoringScheduleName' => 'The name of the monitoring schedule.
', 'MonitoringScheduleSummary$MonitoringScheduleName' => 'The name of the monitoring schedule.
', 'StartMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the schedule to start.
', 'StopMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the schedule to stop.
', 'UpdateMonitoringAlertRequest$MonitoringScheduleName' => 'The name of a monitoring schedule.
', 'UpdateMonitoringScheduleRequest$MonitoringScheduleName' => 'The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
', ], ], 'MonitoringScheduleSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesRequest$SortBy' => 'Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.
Summarizes the monitoring schedule.
', 'refs' => [ 'MonitoringScheduleSummaryList$member' => NULL, ], ], 'MonitoringScheduleSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesResponse$MonitoringScheduleSummaries' => 'A JSON array in which each element is a summary for a monitoring schedule.
', ], ], 'MonitoringStatisticsResource' => [ 'base' => 'The statistics resource for a monitoring job.
', 'refs' => [ 'DataQualityBaselineConfig$StatisticsResource' => NULL, 'MonitoringBaselineConfig$StatisticsResource' => 'The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
', ], ], 'MonitoringStoppingCondition' => [ 'base' => 'A time limit for how long the monitoring job is allowed to run before stopping.
', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelBiasJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelQualityJobDefinitionRequest$StoppingCondition' => NULL, 'DescribeDataQualityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelBiasJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelQualityJobDefinitionResponse$StoppingCondition' => NULL, 'MonitoringJobDefinition$StoppingCondition' => 'Specifies a time limit for how long the monitoring job is allowed to run.
', ], ], 'MonitoringTimeOffsetString' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$StartTimeOffset' => '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.
', 'BatchTransformInput$EndTimeOffset' => '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.
', 'EndpointInput$StartTimeOffset' => '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.
', 'EndpointInput$EndTimeOffset' => '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.
', ], ], 'MonitoringType' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringType' => '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 filter that returns only the monitoring job runs of the specified monitoring type.
', 'ListMonitoringSchedulesRequest$MonitoringTypeEquals' => 'A filter that returns only the monitoring schedules for the specified monitoring type.
', 'ModelDashboardMonitoringSchedule$MonitoringType' => 'The monitor type of a model monitor.
', 'MonitoringExecutionSummary$MonitoringType' => 'The type of the monitoring job.
', 'MonitoringSchedule$MonitoringType' => 'The type of the monitoring job definition to schedule.
', 'MonitoringScheduleConfig$MonitoringType' => 'The type of the monitoring job definition to schedule.
', 'MonitoringScheduleSummary$MonitoringType' => 'The type of the monitoring job definition that the schedule is for.
', ], ], 'MountPath' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$MountPath' => '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.
', ], ], 'MultiModelConfig' => [ 'base' => 'Specifies additional configuration for hosting multi-model endpoints.
', 'refs' => [ 'ContainerDefinition$MultiModelConfig' => 'Specifies additional configuration for multi-model endpoints.
', ], ], 'NameContains' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$NameContains' => 'A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
', 'ListCompilationJobsRequest$NameContains' => 'A filter that returns the model compilation jobs whose name contains a specified string.
', 'ListDataQualityJobDefinitionsRequest$NameContains' => '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.
', 'ListDeviceFleetsRequest$NameContains' => 'Filter for fleets containing this name in their fleet device name.
', 'ListEdgeDeploymentPlansRequest$NameContains' => 'Selects edge deployment plans with names containing this name.
', 'ListEdgeDeploymentPlansRequest$DeviceFleetNameContains' => 'Selects edge deployment plans with a device fleet name containing this name.
', 'ListEdgePackagingJobsRequest$NameContains' => 'Filter for jobs containing this name in their packaging job name.
', 'ListEdgePackagingJobsRequest$ModelNameContains' => 'Filter for jobs where the model name contains this string.
', 'ListHubContentsRequest$NameContains' => 'Only list hub content if the name contains the specified string.
', 'ListHubsRequest$NameContains' => 'Only list hubs with names that contain the specified string.
', 'ListHyperParameterTuningJobsRequest$NameContains' => 'A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
', 'ListInferenceExperimentsRequest$NameContains' => 'Selects inference experiments whose names contain this name.
', 'ListInferenceRecommendationsJobsRequest$NameContains' => 'A string in the job name. This filter returns only recommendations whose name contains the specified string.
', 'ListLabelingJobsRequest$NameContains' => 'A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
', 'ListModelBiasJobDefinitionsRequest$NameContains' => 'Filter for model bias jobs whose name contains a specified string.
', 'ListModelExplainabilityJobDefinitionsRequest$NameContains' => 'Filter for model explainability jobs whose name contains a specified string.
', 'ListModelPackageGroupsInput$NameContains' => 'A string in the model group name. This filter returns only model groups whose name contains the specified string.
', 'ListModelPackagesInput$NameContains' => 'A string in the model package name. This filter returns only model packages whose name contains the specified string.
', 'ListModelQualityJobDefinitionsRequest$NameContains' => 'A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.
', 'ListMonitoringSchedulesRequest$NameContains' => 'Filter for monitoring schedules whose name contains a specified string.
', 'ListTrainingJobsRequest$NameContains' => 'A string in the training job name. This filter returns only training jobs whose name contains the specified string.
', 'ListTransformJobsRequest$NameContains' => 'A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
', ], ], 'NeoVpcConfig' => [ 'base' => '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 Compilation Jobs Access to Resources in Your Amazon VPC.
', 'refs' => [ 'CreateCompilationJobRequest$VpcConfig' => '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.
', 'DescribeCompilationJobResponse$VpcConfig' => '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.
', ], ], 'NeoVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSecurityGroupIds$member' => NULL, ], ], 'NeoVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$SecurityGroupIds' => '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 accessing the model in Amazon S3.
', ], ], 'NestedFilters' => [ 'base' => '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"}\'
A list of nested filter objects.
', ], ], 'NetworkConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateProcessingJobRequest$NetworkConfig' => '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.
', 'DescribeProcessingJobResponse$NetworkConfig' => 'Networking options for a processing job.
', 'MonitoringJobDefinition$NetworkConfig' => 'Specifies networking options for an monitoring job.
', 'ProcessingJob$NetworkConfig' => NULL, ], ], 'NetworkInterfaceId' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NetworkInterfaceId' => 'The network interface IDs that SageMaker created at the time of creating the instance.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceRequest$NextToken' => 'Next token of device description.
', 'DescribeDeviceResponse$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'DescribeEdgeDeploymentPlanRequest$NextToken' => 'If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.
', 'DescribeEdgeDeploymentPlanResponse$NextToken' => 'Token to use when calling the next set of stages in the edge deployment plan.
', 'DescribeFeatureGroupRequest$NextToken' => 'A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.
A token to resume pagination of the list of Features (FeatureDefinitions).
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 token for getting the next set of actions, if there are any.
', 'ListAlgorithmsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
', 'ListAliasesRequest$NextToken' => '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.
A token for getting the next set of aliases, if more aliases exist.
', 'ListAppImageConfigsRequest$NextToken' => '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.
A token for getting the next set of AppImageConfigs, if there are any.
', 'ListAppsRequest$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListAppsResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListArtifactsRequest$NextToken' => '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.
A token for getting the next set of artifacts, if there are any.
', 'ListAssociationsRequest$NextToken' => '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.
A token for getting the next set of associations, if there are any.
', 'ListAutoMLJobsRequest$NextToken' => 'If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
', 'ListAutoMLJobsResponse$NextToken' => 'If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
', 'ListCandidatesForAutoMLJobRequest$NextToken' => 'If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
', 'ListCandidatesForAutoMLJobResponse$NextToken' => 'If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
', 'ListCodeRepositoriesInput$NextToken' => '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.
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.
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.
If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.
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 token for getting the next set of contexts, if there are any.
', 'ListDataQualityJobDefinitionsRequest$NextToken' => '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.>
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.
The response from the last list when returning a list large enough to need tokening.
', 'ListDeviceFleetsResponse$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListDevicesRequest$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListDevicesResponse$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListDomainsRequest$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListDomainsResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListEdgeDeploymentPlansRequest$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListEdgeDeploymentPlansResponse$NextToken' => 'The token to use when calling the next page of results.
', 'ListEdgePackagingJobsRequest$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListEdgePackagingJobsResponse$NextToken' => 'Token to use when calling the next page of results.
', 'ListExperimentsRequest$NextToken' => '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.
A token for getting the next set of experiments, if there are any.
', 'ListFeatureGroupsRequest$NextToken' => 'A token to resume pagination of ListFeatureGroups results.
A token to resume pagination of ListFeatureGroups results.
A token to resume pagination.
', 'ListFlowDefinitionsResponse$NextToken' => 'A token to resume pagination.
', 'ListHubContentVersionsRequest$NextToken' => 'If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.
', 'ListHubContentsRequest$NextToken' => 'If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.
', 'ListHubsRequest$NextToken' => 'If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
', 'ListHumanTaskUisRequest$NextToken' => 'A token to resume pagination.
', 'ListHumanTaskUisResponse$NextToken' => 'A token to resume pagination.
', 'ListHyperParameterTuningJobsRequest$NextToken' => '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.
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.
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.
A token for getting the next set of versions, if there are any.
', 'ListImagesRequest$NextToken' => '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.
A token for getting the next set of images, if there are any.
', 'ListInferenceExperimentsRequest$NextToken' => 'The response from the last list when returning a list large enough to need tokening.
', 'ListInferenceExperimentsResponse$NextToken' => 'The token to use when calling the next page of results.
', 'ListInferenceRecommendationsJobStepsRequest$NextToken' => 'A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.
', 'ListInferenceRecommendationsJobStepsResponse$NextToken' => 'A token that you can specify in your next request to return more results from the list.
', 'ListInferenceRecommendationsJobsRequest$NextToken' => '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.
A token for getting the next set of recommendations, if there are any.
', 'ListLabelingJobsForWorkteamRequest$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
', 'ListLabelingJobsRequest$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
', 'ListLineageGroupsRequest$NextToken' => 'If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
', 'ListLineageGroupsResponse$NextToken' => 'If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
', 'ListModelBiasJobDefinitionsRequest$NextToken' => 'The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
', 'ListModelBiasJobDefinitionsResponse$NextToken' => 'If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
', 'ListModelCardExportJobsRequest$NextToken' => '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 card export jobs, use it in the subsequent request.
', 'ListModelCardVersionsRequest$NextToken' => '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 card versions, use it in the subsequent request.
', 'ListModelCardsRequest$NextToken' => '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 cards, use it in the subsequent request.
', 'ListModelExplainabilityJobDefinitionsRequest$NextToken' => 'The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
', 'ListModelExplainabilityJobDefinitionsResponse$NextToken' => 'If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
', 'ListModelMetadataRequest$NextToken' => '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 token for getting the next set of recommendations, if there are any.
', 'ListModelPackageGroupsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.
', 'ListModelPackagesInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
', 'ListModelQualityJobDefinitionsRequest$NextToken' => '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.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.
', 'ListMonitoringAlertHistoryRequest$NextToken' => '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 alerts, use it in the subsequent request.
', 'ListMonitoringAlertsRequest$NextToken' => '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 alerts, use it in the subsequent request.
', 'ListMonitoringExecutionsRequest$NextToken' => 'The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
', 'ListMonitoringExecutionsResponse$NextToken' => 'If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent reques
', 'ListMonitoringSchedulesRequest$NextToken' => 'The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
', 'ListMonitoringSchedulesResponse$NextToken' => 'If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
', 'ListNotebookInstanceLifecycleConfigsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.
', 'ListNotebookInstancesInput$NextToken' => ' 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.
If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, 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.
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.
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 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, 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 ListPipelines request was truncated, 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.
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.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.
', 'ListProjectsInput$NextToken' => '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, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.
A token to resume pagination of ListResourceCatalogs results.
A token to resume pagination of ListResourceCatalogs results.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListSpacesResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListStageDevicesRequest$NextToken' => 'The response from the last list when returning a list large enough to neeed tokening.
', 'ListStageDevicesResponse$NextToken' => 'The token to use when calling the next page of results.
', 'ListStudioLifecycleConfigsRequest$NextToken' => '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.
', 'ListStudioLifecycleConfigsResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListSubscribedWorkteamsRequest$NextToken' => '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 work teams, use it in the subsequent request.
', 'ListTagsInput$NextToken' => ' 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 token in your subsequent request to fetch next set of tokens.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$NextToken' => '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.
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, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
', 'ListTransformJobsRequest$NextToken' => '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.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.
', 'ListTrialComponentsRequest$NextToken' => '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.
A token for getting the next set of components, if there are any.
', 'ListTrialsRequest$NextToken' => '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.
A token for getting the next set of trials, if there are any.
', 'ListUserProfilesRequest$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListUserProfilesResponse$NextToken' => 'If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
', 'ListWorkforcesRequest$NextToken' => 'A token to resume pagination.
', 'ListWorkforcesResponse$NextToken' => 'A token to resume pagination.
', 'ListWorkteamsRequest$NextToken' => '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 work teams, use it in the subsequent request.
', 'SearchRequest$NextToken' => '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.
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.
A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
', 'DescribeNotebookInstanceOutput$AcceleratorTypes' => 'A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
', 'UpdateNotebookInstanceInput$AcceleratorTypes' => 'A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
', ], ], 'NotebookInstanceArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceOutput$NotebookInstanceArn' => 'The Amazon Resource Name (ARN) of the notebook instance.
', 'DescribeNotebookInstanceOutput$NotebookInstanceArn' => 'The Amazon Resource Name (ARN) of the notebook instance.
', 'NotebookInstanceSummary$NotebookInstanceArn' => 'The Amazon Resource Name (ARN) of the notebook instance.
', ], ], 'NotebookInstanceLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the lifecycle configuration.
', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the lifecycle configuration.
', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the lifecycle configuration.
', ], ], 'NotebookInstanceLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceLifecycleHook$Content' => 'A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
', ], ], 'NotebookInstanceLifecycleConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigInput$OnCreate' => 'A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
', 'CreateNotebookInstanceLifecycleConfigInput$OnStart' => '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.
', 'DescribeNotebookInstanceLifecycleConfigOutput$OnCreate' => 'The shell script that runs only once, when you create a notebook instance.
', 'DescribeNotebookInstanceLifecycleConfigOutput$OnStart' => 'The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
', 'UpdateNotebookInstanceLifecycleConfigInput$OnCreate' => 'The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
', 'UpdateNotebookInstanceLifecycleConfigInput$OnStart' => '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.
', ], ], 'NotebookInstanceLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$LifecycleConfigName' => '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.
', 'CreateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration.
', 'DeleteNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration to delete.
', 'DescribeNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration to describe.
', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration.
', 'DescribeNotebookInstanceOutput$NotebookInstanceLifecycleConfigName' => '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
', 'ListNotebookInstancesInput$NotebookInstanceLifecycleConfigNameContains' => '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.
', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration.
', 'NotebookInstanceSummary$NotebookInstanceLifecycleConfigName' => '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.
', 'UpdateNotebookInstanceInput$LifecycleConfigName' => '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.
', 'UpdateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => 'The name of the lifecycle configuration.
', ], ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$NameContains' => 'A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
', ], ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortBy' => 'Sorts the list of results. The default is CreationTime.
The sort order for results.
', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'base' => 'Provides a summary of a notebook instance lifecycle configuration.
', 'refs' => [ 'NotebookInstanceLifecycleConfigSummaryList$member' => NULL, ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsOutput$NotebookInstanceLifecycleConfigs' => 'An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.
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 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.
', 'refs' => [ 'NotebookInstanceLifecycleConfigList$member' => NULL, ], ], 'NotebookInstanceName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$NotebookInstanceName' => 'The name of the new notebook instance.
', 'CreatePresignedNotebookInstanceUrlInput$NotebookInstanceName' => 'The name of the notebook instance.
', 'DeleteNotebookInstanceInput$NotebookInstanceName' => 'The name of the SageMaker notebook instance to delete.
', 'DescribeNotebookInstanceInput$NotebookInstanceName' => 'The name of the notebook instance that you want information about.
', 'DescribeNotebookInstanceOutput$NotebookInstanceName' => 'The name of the SageMaker notebook instance.
', 'NotebookInstanceSummary$NotebookInstanceName' => 'The name of the notebook instance that you want a summary for.
', 'StartNotebookInstanceInput$NotebookInstanceName' => 'The name of the notebook instance to start.
', 'StopNotebookInstanceInput$NotebookInstanceName' => 'The name of the notebook instance to terminate.
', 'UpdateNotebookInstanceInput$NotebookInstanceName' => 'The name of the notebook instance to update.
', ], ], 'NotebookInstanceNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$NameContains' => 'A string in the notebook instances\' name. This filter returns only notebook instances whose name contains the specified string.
', ], ], 'NotebookInstanceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortBy' => 'The field to sort results by. The default is Name.
The sort order for results.
', ], ], 'NotebookInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NotebookInstanceStatus' => 'The status of the notebook instance.
', 'ListNotebookInstancesInput$StatusEquals' => 'A filter that returns only notebook instances with the specified status.
', 'NotebookInstanceSummary$NotebookInstanceStatus' => 'The status of the notebook instance.
', ], ], 'NotebookInstanceSummary' => [ 'base' => 'Provides summary information for an SageMaker notebook instance.
', 'refs' => [ 'NotebookInstanceSummaryList$member' => NULL, ], ], 'NotebookInstanceSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesOutput$NotebookInstances' => 'An array of NotebookInstanceSummary objects, one for each notebook instance.
A JSON object that contains the URL string.
', 'DescribeNotebookInstanceOutput$Url' => 'The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
', 'NotebookInstanceSummary$Url' => 'The URL that you use to connect to the Jupyter notebook running in your notebook instance.
', ], ], 'NotebookInstanceVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$VolumeSizeInGB' => 'The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
', 'DescribeNotebookInstanceOutput$VolumeSizeInGB' => 'The size, in GB, of the ML storage volume attached to the notebook instance.
', 'UpdateNotebookInstanceInput$VolumeSizeInGB' => '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 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.
', ], ], 'NotebookOutputOption' => [ 'base' => NULL, 'refs' => [ 'SharingSettings$NotebookOutputOption' => 'Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
Configures Amazon SNS notifications of available or expiring work items for work teams.
', 'refs' => [ 'CreateWorkteamRequest$NotificationConfiguration' => 'Configures notification of workers regarding available or expiring work items.
', 'UpdateWorkteamRequest$NotificationConfiguration' => 'Configures SNS topic notifications for available or expiring work items
', 'Workteam$NotificationConfiguration' => 'Configures SNS notifications of available or expiring work items for work teams.
', ], ], 'NotificationTopicArn' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$NotificationTopicArn' => 'The ARN for the Amazon SNS topic to which notifications should be published.
', ], ], 'NumberOfHumanWorkersPerDataObject' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$NumberOfHumanWorkersPerDataObject' => 'The number of human workers that will label an object.
', 'LabelingJobForWorkteamSummary$NumberOfHumanWorkersPerDataObject' => 'The configured number of workers per data object.
', ], ], 'NumberOfSteps' => [ 'base' => NULL, 'refs' => [ 'Stairs$NumberOfSteps' => 'Specifies how many steps to perform during traffic.
', ], ], 'ObjectiveStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$ObjectiveStatus' => 'The objective\'s status.
', 'HyperParameterTrainingJobSummary$ObjectiveStatus' => 'The 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 number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
', 'ObjectiveStatusCounters$Pending' => 'The number of training jobs that are in progress and pending evaluation of their final objective metric.
', 'ObjectiveStatusCounters$Failed' => '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.
', ], ], 'ObjectiveStatusCounters' => [ 'base' => '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.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters' => 'The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
', 'HyperParameterTuningJobSearchEntity$ObjectiveStatusCounters' => NULL, 'HyperParameterTuningJobSummary$ObjectiveStatusCounters' => 'The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
', ], ], 'OfflineStoreConfig' => [ 'base' => '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.
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.
', 'DescribeFeatureGroupResponse$OfflineStoreConfig' => 'The 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 status of OfflineStore.
The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked
Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.
An OfflineStore status. Filters by OfflineStore status.
An OfflineStore status.
Use this parameter to configure your OIDC Identity Provider (IdP).
', 'refs' => [ 'CreateWorkforceRequest$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.
Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.
', ], ], 'OidcConfigForResponse' => [ 'base' => 'Your OIDC IdP workforce configuration.
', 'refs' => [ 'Workforce$OidcConfig' => 'The configuration of an OIDC Identity Provider (IdP) private workforce.
', ], ], 'OidcEndpoint' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$Issuer' => 'The OIDC IdP issuer used to configure your private workforce.
', 'OidcConfig$AuthorizationEndpoint' => 'The OIDC IdP authorization endpoint used to configure your private workforce.
', 'OidcConfig$TokenEndpoint' => 'The OIDC IdP token endpoint used to configure your private workforce.
', 'OidcConfig$UserInfoEndpoint' => 'The OIDC IdP user information endpoint used to configure your private workforce.
', 'OidcConfig$LogoutEndpoint' => 'The OIDC IdP logout endpoint used to configure your private workforce.
', 'OidcConfig$JwksUri' => 'The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
', 'OidcConfigForResponse$Issuer' => 'The OIDC IdP issuer used to configure your private workforce.
', 'OidcConfigForResponse$AuthorizationEndpoint' => 'The OIDC IdP authorization endpoint used to configure your private workforce.
', 'OidcConfigForResponse$TokenEndpoint' => 'The OIDC IdP token endpoint used to configure your private workforce.
', 'OidcConfigForResponse$UserInfoEndpoint' => 'The OIDC IdP user information endpoint used to configure your private workforce.
', 'OidcConfigForResponse$LogoutEndpoint' => 'The OIDC IdP logout endpoint used to configure your private workforce.
', 'OidcConfigForResponse$JwksUri' => 'The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
', ], ], 'OidcMemberDefinition' => [ 'base' => '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.
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.
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.
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.
The configuration for the OnlineStore.
Updates the feature group online store configuration.
', 'refs' => [ 'UpdateFeatureGroupRequest$OnlineStoreConfig' => 'Updates the feature group online store configuration.
', ], ], 'OnlineStoreSecurityConfig' => [ 'base' => 'The security configuration for OnlineStore.
Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
The size of the OnlineStore in bytes.
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."
The maximum value of the metric.
', 'TrialComponentMetricSummary$Min' => 'The minimum value of the metric.
', 'TrialComponentMetricSummary$Last' => 'The most recent value of the metric.
', 'TrialComponentMetricSummary$Avg' => 'The average value of the metric.
', 'TrialComponentMetricSummary$StdDev' => 'The standard deviation of the metric.
', ], ], 'OptionalInteger' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Count' => 'The number of samples used to generate the metric.
', ], ], 'OptionalVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$VolumeSizeInGB' => 'The size, in GB, of the ML storage volume attached to the processing instance.
', 'HyperParameterTuningResourceConfig$VolumeSizeInGB' => 'The 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.
The size, in GB, of the ML storage volume attached to the processing instance.
', ], ], 'OrderKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortOrder' => 'The sort order for results. The default is Descending.
The sort order for results. The default is Descending.
The sort order for results. The default is Descending.
The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
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.
Provides information about the output location for the compiled model and the target device the model runs on.
', 'DescribeCompilationJobResponse$OutputConfig' => 'Information about the output location for the compiled model and the target device that the model runs on.
', ], ], 'OutputDataConfig' => [ 'base' => 'Provides information about how to store model training results (model artifacts).
', 'refs' => [ 'CreateTrainingJobRequest$OutputDataConfig' => 'Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
', 'DescribeTrainingJobResponse$OutputDataConfig' => 'The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
', 'HyperParameterTrainingJobDefinition$OutputDataConfig' => 'Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
', 'TrainingJob$OutputDataConfig' => 'The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
', 'TrainingJobDefinition$OutputDataConfig' => 'the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
', ], ], 'OutputParameter' => [ 'base' => 'An output parameter of a pipeline step.
', 'refs' => [ 'OutputParameterList$member' => NULL, ], ], 'OutputParameterList' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$OutputParameters' => 'A list of the output parameters of the callback step.
', 'LambdaStepMetadata$OutputParameters' => 'A list of the output parameters of the Lambda step.
', 'SendPipelineExecutionStepSuccessRequest$OutputParameters' => 'A list of the output parameters of the callback step.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request
', 'ListEndpointsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
', 'ListModelsInput$NextToken' => '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.
If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.
', ], ], 'ParallelismConfiguration' => [ 'base' => 'Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.
', 'refs' => [ 'CreatePipelineRequest$ParallelismConfiguration' => 'This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.
', 'DescribePipelineExecutionResponse$ParallelismConfiguration' => 'The parallelism configuration applied to the pipeline.
', 'DescribePipelineResponse$ParallelismConfiguration' => 'Lists the parallelism configuration applied to the pipeline.
', 'Pipeline$ParallelismConfiguration' => 'The parallelism configuration applied to the pipeline.
', 'PipelineExecution$ParallelismConfiguration' => 'The parallelism configuration applied to the pipeline execution.
', 'RetryPipelineExecutionRequest$ParallelismConfiguration' => 'This configuration, if specified, overrides the parallelism configuration of the parent pipeline.
', 'StartPipelineExecutionRequest$ParallelismConfiguration' => 'This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
', 'UpdatePipelineExecutionRequest$ParallelismConfiguration' => 'This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
', 'UpdatePipelineRequest$ParallelismConfiguration' => 'If specified, it applies to all executions of this pipeline by default.
', ], ], 'Parameter' => [ 'base' => 'Assigns a value to a named Pipeline parameter.
', 'refs' => [ 'ParameterList$member' => NULL, ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$Name' => 'The name of the hyperparameter to optimize using Autotune.
', 'CategoricalParameterRange$Name' => 'The name of the categorical hyperparameter to tune.
', 'ContinuousParameterRange$Name' => 'The name of the continuous hyperparameter to tune.
', 'IntegerParameterRange$Name' => 'The name of the hyperparameter to search.
', ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineParametersForExecutionResponse$PipelineParameters' => 'Contains a list of pipeline parameters. This list can be empty.
', 'PipelineExecution$PipelineParameters' => 'Contains a list of pipeline parameters. This list can be empty.
', 'StartPipelineExecutionRequest$PipelineParameters' => 'Contains a list of pipeline parameters. This list can be empty.
', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Name' => 'The name of this hyperparameter. The name must be unique.
', ], ], 'ParameterRange' => [ 'base' => 'Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.
', 'refs' => [ 'HyperParameterSpecification$Range' => 'The allowed range for this hyperparameter.
', ], ], 'ParameterRanges' => [ 'base' => '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 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.
', ], ], 'ParameterType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Type' => 'The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.
An example value of the hyperparameter to optimize using Autotune.
', 'ContinuousParameterRange$MinValue' => '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 between MinValue value and this value for tuning.
The minimum floating-point value allowed.
', 'ContinuousParameterRangeSpecification$MaxValue' => 'The maximum floating-point value allowed.
', 'IntegerParameterRange$MinValue' => 'The minimum value of the hyperparameter to search.
', 'IntegerParameterRange$MaxValue' => 'The maximum value of the hyperparameter to search.
', 'IntegerParameterRangeSpecification$MinValue' => 'The minimum integer value allowed.
', 'IntegerParameterRangeSpecification$MaxValue' => 'The maximum integer value allowed.
', 'ParameterValues$member' => NULL, ], ], 'ParameterValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRange$Values' => 'A list of the categories for the hyperparameter.
', 'CategoricalParameterRangeSpecification$Values' => 'The allowed categories for the hyperparameter.
', ], ], 'Parent' => [ 'base' => '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.
', 'refs' => [ 'Parents$member' => NULL, ], ], 'ParentHyperParameterTuningJob' => [ 'base' => 'A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
', 'refs' => [ 'ParentHyperParameterTuningJobs$member' => NULL, ], ], 'ParentHyperParameterTuningJobs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$ParentHyperParameterTuningJobs' => '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.
', ], ], 'Parents' => [ 'base' => NULL, 'refs' => [ 'TrialComponent$Parents' => '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.
', ], ], 'PendingDeploymentSummary' => [ 'base' => 'The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.
', 'refs' => [ 'DescribeEndpointOutput$PendingDeploymentSummary' => '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.
', ], ], 'PendingProductionVariantSummary' => [ 'base' => '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.
An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.
', 'PendingDeploymentSummary$ShadowProductionVariants' => '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.
Percentage of devices in the fleet to deploy to the current stage.
', 'ShadowModelVariantConfig$SamplingPercentage' => 'The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.
', ], ], 'Phase' => [ 'base' => 'Defines the traffic pattern.
', 'refs' => [ 'Phases$member' => NULL, ], ], 'Phases' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$Phases' => 'Defines the phases traffic specification.
', ], ], 'Pipeline' => [ 'base' => 'A SageMaker Model Building Pipeline instance.
', 'refs' => [ 'SearchRecord$Pipeline' => NULL, ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the created pipeline.
', 'DeletePipelineResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline to delete.
', 'DescribePipelineExecutionResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'DescribePipelineResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'Pipeline$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'PipelineExecution$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline that was executed.
', 'PipelineSummary$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'UpdatePipelineResponse$PipelineArn' => 'The Amazon Resource Name (ARN) of the updated pipeline.
', ], ], 'PipelineDefinition' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDefinition' => 'The JSON pipeline definition of the pipeline.
', 'DescribePipelineDefinitionForExecutionResponse$PipelineDefinition' => 'The JSON pipeline definition.
', 'DescribePipelineResponse$PipelineDefinition' => 'The JSON pipeline definition.
', 'UpdatePipelineRequest$PipelineDefinition' => 'The JSON pipeline definition.
', ], ], 'PipelineDefinitionS3Location' => [ 'base' => 'The location of the pipeline definition stored in Amazon S3.
', 'refs' => [ 'CreatePipelineRequest$PipelineDefinitionS3Location' => 'The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
', 'UpdatePipelineRequest$PipelineDefinitionS3Location' => 'The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
', ], ], 'PipelineDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDescription' => 'A description of the pipeline.
', 'DescribePipelineResponse$PipelineDescription' => 'The description of the pipeline.
', 'Pipeline$PipelineDescription' => 'The description of the pipeline.
', 'PipelineSummary$PipelineDescription' => 'The description of the pipeline.
', 'UpdatePipelineRequest$PipelineDescription' => 'The description of the pipeline.
', ], ], 'PipelineExecution' => [ 'base' => 'An execution of a pipeline.
', 'refs' => [ 'SearchRecord$PipelineExecution' => NULL, ], ], 'PipelineExecutionArn' => [ 'base' => NULL, 'refs' => [ 'CacheHitResult$SourcePipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'DescribePipelineDefinitionForExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'DescribePipelineExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'DescribePipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'ListPipelineExecutionStepsRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'ListPipelineParametersForExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'PipelineExecution$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'PipelineExecutionSummary$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'RetryPipelineExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'RetryPipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'SelectiveExecutionConfig$SourcePipelineExecutionArn' => '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.
The ARN from an execution of the current pipeline.
', 'SendPipelineExecutionStepFailureResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'SendPipelineExecutionStepSuccessResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'StartPipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'StopPipelineExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'StopPipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'UpdatePipelineExecutionRequest$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the pipeline execution.
', 'UpdatePipelineExecutionResponse$PipelineExecutionArn' => 'The Amazon Resource Name (ARN) of the updated pipeline execution.
', ], ], 'PipelineExecutionDescription' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDescription' => 'The description of the pipeline execution.
', 'PipelineExecution$PipelineExecutionDescription' => 'The description of the pipeline execution.
', 'PipelineExecutionSummary$PipelineExecutionDescription' => 'The description of the pipeline execution.
', 'StartPipelineExecutionRequest$PipelineExecutionDescription' => 'The description of the pipeline execution.
', 'UpdatePipelineExecutionRequest$PipelineExecutionDescription' => 'The description of the pipeline execution.
', ], ], 'PipelineExecutionFailureReason' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$FailureReason' => 'If the execution failed, a message describing why.
', 'PipelineExecution$FailureReason' => 'If the execution failed, a message describing why.
', ], ], 'PipelineExecutionName' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', 'PipelineExecution$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', 'PipelineExecutionSummary$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', 'StartPipelineExecutionRequest$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', 'UpdatePipelineExecutionRequest$PipelineExecutionDisplayName' => 'The display name of the pipeline execution.
', ], ], 'PipelineExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionStatus' => 'The status of the pipeline execution.
', 'PipelineExecution$PipelineExecutionStatus' => 'The status of the pipeline status.
', 'PipelineExecutionSummary$PipelineExecutionStatus' => 'The status of the pipeline execution.
', ], ], 'PipelineExecutionStep' => [ 'base' => 'An execution of a step in a pipeline.
', 'refs' => [ 'PipelineExecutionStepList$member' => NULL, ], ], 'PipelineExecutionStepList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionStepsResponse$PipelineExecutionSteps' => '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.
Metadata for a step execution.
', 'refs' => [ 'PipelineExecutionStep$Metadata' => 'Metadata to run the pipeline step.
', ], ], 'PipelineExecutionSummary' => [ 'base' => 'A pipeline execution summary.
', 'refs' => [ 'PipelineExecutionSummaryList$member' => NULL, ], ], 'PipelineExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsResponse$PipelineExecutionSummaries' => '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.
', ], ], 'PipelineExperimentConfig' => [ 'base' => 'Specifies the names of the experiment and trial created by a pipeline.
', 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExperimentConfig' => NULL, 'PipelineExecution$PipelineExperimentConfig' => NULL, ], ], 'PipelineName' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineName' => 'The name of the pipeline.
', 'CreatePipelineRequest$PipelineDisplayName' => 'The display name of the pipeline.
', 'DeletePipelineRequest$PipelineName' => 'The name of the pipeline to delete.
', 'DescribePipelineResponse$PipelineName' => 'The name of the pipeline.
', 'DescribePipelineResponse$PipelineDisplayName' => 'The display name of the pipeline.
', 'ListPipelinesRequest$PipelineNamePrefix' => 'The prefix of the pipeline name.
', 'Pipeline$PipelineName' => 'The name of the pipeline.
', 'Pipeline$PipelineDisplayName' => 'The display name of the pipeline.
', 'PipelineSummary$PipelineName' => 'The name of the pipeline.
', 'PipelineSummary$PipelineDisplayName' => 'The display name of the pipeline.
', 'UpdatePipelineRequest$PipelineName' => 'The name of the pipeline to update.
', 'UpdatePipelineRequest$PipelineDisplayName' => 'The display name of the pipeline.
', ], ], 'PipelineNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineRequest$PipelineName' => 'The name or Amazon Resource Name (ARN) of the pipeline to describe.
', 'ListPipelineExecutionsRequest$PipelineName' => 'The name or Amazon Resource Name (ARN) of the pipeline.
', 'StartPipelineExecutionRequest$PipelineName' => 'The name or Amazon Resource Name (ARN) of the pipeline.
', ], ], 'PipelineParameterName' => [ 'base' => NULL, 'refs' => [ 'Parameter$Name' => 'The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.
', ], ], 'PipelineStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineResponse$PipelineStatus' => 'The status of the pipeline execution.
', 'Pipeline$PipelineStatus' => 'The status of the pipeline.
', ], ], 'PipelineSummary' => [ 'base' => 'A summary of a pipeline.
', 'refs' => [ 'PipelineSummaryList$member' => NULL, ], ], 'PipelineSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesResponse$PipelineSummaries' => '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.
The platform identifier of the notebook instance runtime environment.
', 'DescribeNotebookInstanceOutput$PlatformIdentifier' => 'The platform identifier of the notebook instance runtime environment.
', ], ], 'PolicyString' => [ 'base' => NULL, 'refs' => [ 'GetModelPackageGroupPolicyOutput$ResourcePolicy' => 'The resource policy for the model group.
', 'PutModelPackageGroupPolicyInput$ResourcePolicy' => 'The resource policy for the model group.
', ], ], 'PredefinedMetricSpecification' => [ 'base' => 'A specification for a predefined metric.
', 'refs' => [ 'MetricSpecification$Predefined' => 'Information about a predefined metric.
', ], ], 'PresignedDomainUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlResponse$AuthorizedUrl' => 'The presigned URL.
', ], ], 'ProbabilityThresholdAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ProbabilityThresholdAttribute' => 'The threshold for the class probability to be evaluated as a positive result.
', 'EndpointInput$ProbabilityThresholdAttribute' => 'The threshold for the class probability to be evaluated as a positive result.
', ], ], 'ProblemType' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$ProblemType' => 'Defines the type of supervised learning problem available for the candidates. For more information, see Amazon SageMaker Autopilot problem types.
', 'DescribeAutoMLJobResponse$ProblemType' => 'Returns the job\'s problem type.
', 'ResolvedAttributes$ProblemType' => 'The problem type.
', 'TabularJobConfig$ProblemType' => 'The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see Amazon 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 type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see Amazon SageMaker Autopilot problem types.
', ], ], 'ProcessingClusterConfig' => [ 'base' => 'Configuration for the cluster used to run a processing job.
', 'refs' => [ 'ProcessingResources$ClusterConfig' => 'The configuration for the resources in a cluster used to run the processing job.
', ], ], 'ProcessingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$key' => NULL, 'ProcessingEnvironmentMap$key' => NULL, ], ], 'ProcessingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$Environment' => 'The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
', 'DescribeProcessingJobResponse$Environment' => 'The environment variables set in the Docker container.
', 'ProcessingJob$Environment' => 'Sets the environment variables in the Docker container.
', ], ], 'ProcessingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$value' => NULL, 'ProcessingEnvironmentMap$value' => NULL, ], ], 'ProcessingFeatureStoreOutput' => [ 'base' => 'Configuration for processing job outputs in Amazon SageMaker Feature Store.
', 'refs' => [ 'ProcessingOutput$FeatureStoreOutput' => 'Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.
The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.
An array of inputs configuring the data to download into the processing container.
', 'DescribeProcessingJobResponse$ProcessingInputs' => 'The inputs for a processing job.
', 'ProcessingJob$ProcessingInputs' => 'List of input configurations for the processing job.
', ], ], 'ProcessingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$InstanceCount' => '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.
', 'ProcessingClusterConfig$InstanceCount' => '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.
', ], ], 'ProcessingInstanceType' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$InstanceType' => 'The instance type to deploy a custom rule for debugging a training job.
', 'MonitoringClusterConfig$InstanceType' => 'The ML compute instance type for the processing job.
', 'ProcessingClusterConfig$InstanceType' => 'The ML compute instance type for the processing job.
', 'ProfilerRuleConfiguration$InstanceType' => 'The instance type to deploy a custom rule for profiling a training job.
', ], ], 'ProcessingJob' => [ 'base' => 'An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.
', 'refs' => [ 'TrialComponentSourceDetail$ProcessingJob' => 'Information about a processing job that\'s the source of a trial component.
', ], ], 'ProcessingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobResponse$ProcessingJobArn' => 'The Amazon Resource Name (ARN) of the processing job.
', 'DebugRuleEvaluationStatus$RuleEvaluationJobArn' => 'The Amazon Resource Name (ARN) of the rule evaluation job.
', 'DescribeProcessingJobResponse$ProcessingJobArn' => 'The Amazon Resource Name (ARN) of the processing job.
', 'MonitoringExecutionSummary$ProcessingJobArn' => 'The Amazon Resource Name (ARN) of the monitoring job.
', 'ProcessingJob$ProcessingJobArn' => 'The ARN of the processing job.
', 'ProcessingJobStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the processing job.
', 'ProcessingJobSummary$ProcessingJobArn' => 'The Amazon Resource Name (ARN) of the processing job..
', 'ProfilerRuleEvaluationStatus$RuleEvaluationJobArn' => 'The Amazon Resource Name (ARN) of the rule evaluation job.
', ], ], 'ProcessingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingJobName' => 'The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DataQualityBaselineConfig$BaseliningJobName' => 'The name of the job that performs baselining for the data quality monitoring job.
', 'DescribeProcessingJobRequest$ProcessingJobName' => 'The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeProcessingJobResponse$ProcessingJobName' => 'The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'ModelBiasBaselineConfig$BaseliningJobName' => 'The name of the baseline model bias job.
', 'ModelExplainabilityBaselineConfig$BaseliningJobName' => 'The name of the baseline model explainability job.
', 'ModelQualityBaselineConfig$BaseliningJobName' => 'The name of the job that performs baselining for the monitoring job.
', 'MonitoringBaselineConfig$BaseliningJobName' => 'The name of the job that performs baselining for the monitoring job.
', 'ProcessingJob$ProcessingJobName' => 'The name of the processing job.
', 'ProcessingJobSummary$ProcessingJobName' => 'The name of the processing job.
', 'StopProcessingJobRequest$ProcessingJobName' => 'The name of the processing job to stop.
', ], ], 'ProcessingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ProcessingJobStatus' => 'Provides the status of a processing job.
', 'ListProcessingJobsRequest$StatusEquals' => 'A filter that retrieves only processing jobs with a specific status.
', 'ProcessingJob$ProcessingJobStatus' => 'The status of the processing job.
', 'ProcessingJobSummary$ProcessingJobStatus' => 'The status of the processing job.
', ], ], 'ProcessingJobStepMetadata' => [ 'base' => 'Metadata for a processing job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$ProcessingJob' => 'The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
', ], ], 'ProcessingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListProcessingJobsResponse$ProcessingJobSummaries' => 'An array of ProcessingJobSummary objects, each listing a processing job.
Summary of information about a processing job.
', 'refs' => [ 'ProcessingJobSummaries$member' => NULL, ], ], 'ProcessingLocalPath' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$LocalPath' => 'Path to the filesystem where the batch transform data is available to the container.
', 'DatasetDefinition$LocalPath' => '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).
Path to the filesystem where the endpoint data is available to the container.
', 'MonitoringS3Output$LocalPath' => 'The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.
', 'ProcessingS3Input$LocalPath' => '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).
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.
Specifies the maximum runtime in seconds.
', ], ], 'ProcessingOutput' => [ 'base' => 'Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.
Configuration for uploading output from the processing container.
', 'refs' => [ 'CreateProcessingJobRequest$ProcessingOutputConfig' => 'Output configuration for the processing job.
', 'DescribeProcessingJobResponse$ProcessingOutputConfig' => 'Output configuration for the processing job.
', 'ProcessingJob$ProcessingOutputConfig' => NULL, ], ], 'ProcessingOutputs' => [ 'base' => NULL, 'refs' => [ 'ProcessingOutputConfig$Outputs' => 'An array of outputs configuring the data to upload from the processing container.
', ], ], 'ProcessingResources' => [ 'base' => '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.
', 'refs' => [ 'CreateProcessingJobRequest$ProcessingResources' => '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.
', 'DescribeProcessingJobResponse$ProcessingResources' => '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.
', 'ProcessingJob$ProcessingResources' => NULL, ], ], 'ProcessingS3CompressionType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3CompressionType' => '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.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
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 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.
Configuration for downloading input data from Amazon S3 into the processing container.
', 'refs' => [ 'ProcessingInput$S3Input' => 'Configuration for downloading input data from Amazon S3 into the processing container.
', ], ], 'ProcessingS3InputMode' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3InputMode' => '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 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 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.
Configuration for uploading output data to Amazon S3 from the processing container.
', 'refs' => [ 'ProcessingOutput$S3Output' => 'Configuration for processing job outputs in Amazon S3.
', ], ], 'ProcessingS3UploadMode' => [ 'base' => NULL, 'refs' => [ 'MonitoringS3Output$S3UploadMode' => 'Whether to upload the results of the monitoring job continuously or after the job completes.
', 'ProcessingS3Output$S3UploadMode' => 'Whether to upload the results of the processing job continuously or after the job completes.
', ], ], 'ProcessingStoppingCondition' => [ 'base' => '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.
', 'refs' => [ 'CreateProcessingJobRequest$StoppingCondition' => 'The time limit for how long the processing job is allowed to run.
', 'DescribeProcessingJobResponse$StoppingCondition' => 'The time limit for how long the processing job is allowed to run.
', 'ProcessingJob$StoppingCondition' => NULL, ], ], 'ProcessingVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$VolumeSizeInGB' => 'The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.
', 'ProcessingClusterConfig$VolumeSizeInGB' => 'The 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.
Indicates CPU or GPU compatibility.
CPU: The image version is compatible with CPU.
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.
Indicates CPU or GPU compatibility.
CPU: The image version is compatible with CPU.
GPU: The image version is compatible with GPU.
The product identifier of the algorithm.
', 'ModelPackageContainerDefinition$ProductId' => 'The Amazon Web Services Marketplace product ID of the model package.
', ], ], 'ProductListings' => [ 'base' => NULL, 'refs' => [ 'Workteam$ProductListingIds' => 'The Amazon Marketplace identifier for a vendor\'s work team.
', ], ], 'ProductionVariant' => [ 'base' => '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.
', 'refs' => [ 'ProductionVariantList$member' => NULL, ], ], 'ProductionVariantAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$AcceleratorType' => 'The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
', 'ProductionVariant$AcceleratorType' => 'The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$ContainerStartupHealthCheckTimeoutInSeconds' => '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.
', ], ], 'ProductionVariantCoreDumpConfig' => [ 'base' => 'Specifies configuration for a core dump from the model container when the process crashes.
', 'refs' => [ 'ProductionVariant$CoreDumpConfig' => 'Specifies configuration for a core dump from the model container when the process crashes.
', ], ], 'ProductionVariantInstanceType' => [ 'base' => NULL, 'refs' => [ 'EndpointInputConfiguration$InstanceType' => 'The instance types to use for the load test.
', 'EndpointOutputConfiguration$InstanceType' => 'The instance type recommended by Amazon SageMaker Inference Recommender.
', 'PendingProductionVariantSummary$InstanceType' => 'The type of instances associated with the variant.
', 'ProductionVariant$InstanceType' => 'The ML compute instance type.
', 'RealTimeInferenceRecommendation$InstanceType' => 'The recommended instance type for Real-Time Inference.
', 'RealtimeInferenceInstanceTypes$member' => NULL, ], ], 'ProductionVariantList' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$ProductionVariants' => 'An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
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.
An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
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 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.
', ], ], 'ProductionVariantSSMAccess' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$EnableSSMAccess' => ' 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.
Specifies the serverless configuration for an endpoint variant.
', 'refs' => [ 'EndpointInputConfiguration$ServerlessConfig' => NULL, 'EndpointOutputConfiguration$ServerlessConfig' => NULL, 'PendingProductionVariantSummary$CurrentServerlessConfig' => 'The serverless configuration for the endpoint.
', 'PendingProductionVariantSummary$DesiredServerlessConfig' => 'The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.
', 'ProductionVariant$ServerlessConfig' => 'The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
', 'ProductionVariantSummary$CurrentServerlessConfig' => 'The serverless configuration for the endpoint.
', 'ProductionVariantSummary$DesiredServerlessConfig' => 'The serverless configuration requested for the endpoint update.
', ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'base' => 'Specifies the serverless update concurrency configuration for an endpoint variant.
', 'refs' => [ 'DesiredWeightAndCapacity$ServerlessUpdateConfig' => 'Specifies the serverless update concurrency configuration for an endpoint variant.
', ], ], 'ProductionVariantStatus' => [ 'base' => 'Describes the status of the production variant.
', 'refs' => [ 'ProductionVariantStatusList$member' => NULL, ], ], 'ProductionVariantStatusList' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$VariantStatus' => 'The endpoint variant status which describes the current deployment stage status or operational status.
', 'ProductionVariantSummary$VariantStatus' => 'The endpoint variant status which describes the current deployment stage status or operational status.
', ], ], 'ProductionVariantSummary' => [ 'base' => '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.
An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
', 'DescribeEndpointOutput$ShadowProductionVariants' => '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.
A list of the production variants hosted on the endpoint. Each production variant is a model.
', 'Endpoint$ShadowProductionVariants' => '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.
', ], ], 'ProductionVariantVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$VolumeSizeInGB' => '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.
', ], ], 'ProfilerConfig' => [ 'base' => 'Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
', 'refs' => [ 'CreateTrainingJobRequest$ProfilerConfig' => NULL, 'DescribeTrainingJobResponse$ProfilerConfig' => NULL, 'TrainingJob$ProfilerConfig' => NULL, ], ], 'ProfilerConfigForUpdate' => [ 'base' => 'Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.
', 'refs' => [ 'UpdateTrainingJobRequest$ProfilerConfig' => 'Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
', ], ], 'ProfilerRuleConfiguration' => [ 'base' => 'Configuration information for profiling rules.
', 'refs' => [ 'ProfilerRuleConfigurations$member' => NULL, ], ], 'ProfilerRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$ProfilerRuleConfigurations' => 'Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
', 'DescribeTrainingJobResponse$ProfilerRuleConfigurations' => 'Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
', 'UpdateTrainingJobRequest$ProfilerRuleConfigurations' => 'Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
', ], ], 'ProfilerRuleEvaluationStatus' => [ 'base' => 'Information about the status of the rule evaluation.
', 'refs' => [ 'ProfilerRuleEvaluationStatuses$member' => NULL, ], ], 'ProfilerRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilerRuleEvaluationStatuses' => 'Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.
', ], ], 'ProfilingIntervalInMilliseconds' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingIntervalInMilliseconds' => '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.
', 'ProfilerConfigForUpdate$ProfilingIntervalInMilliseconds' => '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' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingParameters' => '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 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.
Profiling status of a training job.
', ], ], 'ProgrammingLang' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ProgrammingLang' => 'The supported programming language and its version.
', 'DescribeImageVersionResponse$ProgrammingLang' => 'The supported programming language and its version.
', 'UpdateImageVersionRequest$ProgrammingLang' => 'The supported programming language and its version.
', ], ], 'Project' => [ 'base' => 'The properties of a project as returned by the Search API.
', 'refs' => [ 'SearchRecord$Project' => 'The properties of a project.
', ], ], 'ProjectArn' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', 'DescribeProjectOutput$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', 'Project$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', 'ProjectSummary$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', 'UpdateProjectOutput$ProjectArn' => 'The Amazon Resource Name (ARN) of the project.
', ], ], 'ProjectEntityName' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$ProjectName' => 'The name of the project.
', 'DeleteProjectInput$ProjectName' => 'The name of the project to delete.
', 'DescribeProjectInput$ProjectName' => 'The name of the project to describe.
', 'DescribeProjectOutput$ProjectName' => 'The name of the project.
', 'ListProjectsInput$NameContains' => 'A filter that returns the projects whose name contains a specified string.
', 'Project$ProjectName' => 'The name of the project.
', 'ProjectSummary$ProjectName' => 'The name of the project.
', 'UpdateProjectInput$ProjectName' => 'The name of the project.
', ], ], 'ProjectId' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectId' => 'The ID of the new project.
', 'DescribeProjectOutput$ProjectId' => 'The ID of the project.
', 'Project$ProjectId' => 'The ID of the project.
', 'ProjectSummary$ProjectId' => 'The ID of the project.
', ], ], 'ProjectSortBy' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortBy' => 'The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
The status of the project.
', 'Project$ProjectStatus' => 'The status of the project.
', 'ProjectSummary$ProjectStatus' => 'The status of the project.
', ], ], 'ProjectSummary' => [ 'base' => 'Information about a project.
', 'refs' => [ 'ProjectSummaryList$member' => NULL, ], ], 'ProjectSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListProjectsOutput$ProjectSummaryList' => 'A list of summaries of projects.
', ], ], 'PropertyNameHint' => [ 'base' => NULL, 'refs' => [ 'PropertyNameQuery$PropertyNameHint' => 'Text that begins a property\'s name.
', ], ], 'PropertyNameQuery' => [ 'base' => 'Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.
Defines a property name hint. Only property names that begin with the specified hint are included in the response.
', ], ], 'PropertyNameSuggestion' => [ 'base' => 'A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.
A list of property names for a Resource that match a SuggestionQuery.
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.
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.
', 'refs' => [ 'ProvisioningParameters$member' => NULL, ], ], 'ProvisioningParameterKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Key' => 'The key that identifies a provisioning parameter.
', ], ], 'ProvisioningParameterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Value' => 'The value of the provisioning parameter.
', ], ], 'ProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisioningDetails$ProvisioningParameters' => 'A list of key value pairs that you specify when you provision a product.
', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningParameters' => 'A list of key value pairs that you specify when you provision a product.
', ], ], 'PublicWorkforceTaskPrice' => [ 'base' => 'Defines 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
The price that you pay for each task performed by an Amazon Mechanical Turk worker.
', ], ], 'PutModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'PutModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'QualityCheckStepMetadata' => [ 'base' => 'Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.
', 'refs' => [ 'PipelineExecutionStepMetadata$QualityCheck' => '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.
A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.
A 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 of Associations from the StartArn entity to the matched results.
Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.
A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
', ], ], 'QueryLineageTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$LineageTypes' => 'Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.
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.
Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.
A collection of settings that apply to an RSessionGateway app.
A collection of settings that configure the RSessionGateway app.
Indicates whether the current user has access to the RStudioServerPro app.
A collection of settings that configure user interaction with the RStudioServerPro app.
A collection of settings that configure user interaction with the RStudioServerPro app.
A collection of settings that configure the RStudioServerPro Domain-level app.
A collection of settings that configure the RStudioServerPro Domain-level app.
A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.
A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.
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 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.
', ], ], 'RealTimeInferenceConfig' => [ 'base' => 'The infrastructure configuration for deploying the model to a real-time inference endpoint.
', 'refs' => [ 'ModelInfrastructureConfig$RealTimeInferenceConfig' => 'The infrastructure configuration for deploying the model to real-time inference.
', ], ], 'RealTimeInferenceRecommendation' => [ 'base' => 'The recommended configuration to use for Real-Time Inference.
', 'refs' => [ 'RealTimeInferenceRecommendations$member' => NULL, ], ], 'RealTimeInferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RealTimeInferenceRecommendations' => 'A list of RealTimeInferenceRecommendation items.
', ], ], 'RealtimeInferenceInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedRealtimeInferenceInstanceTypes' => 'A list of the instance types that are used to generate inferences in real-time.
', 'InferenceSpecification$SupportedRealtimeInferenceInstanceTypes' => '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.
', ], ], 'RecommendationFailureReason' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInferenceBenchmark$FailureReason' => 'The reason why a benchmark failed.
', ], ], 'RecommendationJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobResponse$JobArn' => 'The Amazon Resource Name (ARN) of the recommendation job.
', 'DescribeInferenceRecommendationsJobResponse$JobArn' => 'The Amazon Resource Name (ARN) of the job.
', 'InferenceRecommendationsJob$JobArn' => 'The Amazon Resource Name (ARN) of the recommendation job.
', ], ], 'RecommendationJobCompilationJobName' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$CompilationJobName' => 'The name of the compilation job used to create the recommended model artifacts.
', ], ], 'RecommendationJobCompiledOutputConfig' => [ 'base' => 'Provides information about the output configuration for the compiled model.
', 'refs' => [ 'RecommendationJobOutputConfig$CompiledOutputConfig' => 'Provides information about the output configuration for the compiled model.
', ], ], 'RecommendationJobContainerConfig' => [ 'base' => '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.
Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.
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.
', ], ], 'RecommendationJobDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobDescription' => 'Description of the recommendation job.
', 'DescribeInferenceRecommendationsJobResponse$JobDescription' => 'The job description that you provided when you initiated the job.
', 'InferenceRecommendationsJob$JobDescription' => 'The job description.
', ], ], 'RecommendationJobInferenceBenchmark' => [ 'base' => 'The details for a specific benchmark from an Inference Recommender job.
', 'refs' => [ 'InferenceRecommendationsJobStep$InferenceBenchmark' => 'The details for a specific benchmark.
', ], ], 'RecommendationJobInputConfig' => [ 'base' => 'The input configuration of the recommendation job.
', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$InputConfig' => 'Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
', 'DescribeInferenceRecommendationsJobResponse$InputConfig' => 'Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.
', ], ], 'RecommendationJobName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobName' => '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.
', 'DescribeInferenceRecommendationsJobRequest$JobName' => 'The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'DescribeInferenceRecommendationsJobResponse$JobName' => 'The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
', 'GetScalingConfigurationRecommendationRequest$InferenceRecommendationsJobName' => 'The name of a previously completed Inference Recommender job.
', 'GetScalingConfigurationRecommendationResponse$InferenceRecommendationsJobName' => 'The name of a previously completed Inference Recommender job.
', 'InferenceRecommendationsJob$JobName' => 'The name of the job.
', 'InferenceRecommendationsJobStep$JobName' => 'The name of the Inference Recommender job.
', 'ListInferenceRecommendationsJobStepsRequest$JobName' => 'The name for the Inference Recommender job.
', 'StopInferenceRecommendationsJobRequest$JobName' => 'The name of the job you want to stop.
', ], ], 'RecommendationJobOutputConfig' => [ 'base' => 'Provides information about the output configuration for the compiled model.
', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$OutputConfig' => 'Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
', ], ], 'RecommendationJobPayloadConfig' => [ 'base' => 'The configuration for the payload for a recommendation job.
', 'refs' => [ 'RecommendationJobContainerConfig$PayloadConfig' => 'Specifies the SamplePayloadUrl and all other sample payload-related fields.
Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.
', 'refs' => [ 'RecommendationJobInputConfig$ResourceLimit' => 'Defines the resource limit of the job.
', ], ], 'RecommendationJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$Status' => 'The status of the job.
', 'InferenceRecommendationsJob$Status' => 'The status of the job.
', 'InferenceRecommendationsJobStep$Status' => 'The current status of the benchmark.
', 'ListInferenceRecommendationsJobStepsRequest$Status' => 'A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
', 'ListInferenceRecommendationsJobsRequest$StatusEquals' => 'A filter that retrieves only inference recommendations jobs with a specific status.
', ], ], 'RecommendationJobStoppingConditions' => [ 'base' => 'Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.
', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$StoppingConditions' => 'A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.
', 'DescribeInferenceRecommendationsJobResponse$StoppingConditions' => 'The stopping conditions that you provided when you initiated the job.
', ], ], 'RecommendationJobSupportedContentTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobPayloadConfig$SupportedContentTypes' => 'The supported MIME types for the input data.
', ], ], 'RecommendationJobSupportedEndpointType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedEndpointType' => '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.
', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedInstanceTypes' => 'A list of the instance types that are used to generate inferences in real-time.
', ], ], 'RecommendationJobType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobType' => '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 job type that you provided when you initiated the job.
', 'InferenceRecommendationsJob$JobType' => 'The recommendation job type.
', ], ], 'RecommendationJobVpcConfig' => [ 'base' => 'Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
', 'refs' => [ 'RecommendationJobInputConfig$VpcConfig' => 'Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
', ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSecurityGroupIds$member' => NULL, ], ], 'RecommendationJobVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$SecurityGroupIds' => '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 to which you want to connect your model.
', ], ], 'RecommendationMetrics' => [ 'base' => 'The metrics of recommendations.
', 'refs' => [ 'InferenceRecommendation$Metrics' => 'The metrics used to decide what recommendation to make.
', 'RecommendationJobInferenceBenchmark$Metrics' => NULL, ], ], 'RecommendationStatus' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RecommendationStatus' => '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.
The type of the subtask.
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.
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.
', ], ], 'RedshiftClusterId' => [ 'base' => 'The Redshift cluster Identifier.
', 'refs' => [ 'RedshiftDatasetDefinition$ClusterId' => NULL, ], ], 'RedshiftDatabase' => [ 'base' => 'The name of the Redshift database used in Redshift query execution.
', 'refs' => [ 'RedshiftDatasetDefinition$Database' => NULL, ], ], 'RedshiftDatasetDefinition' => [ 'base' => 'Configuration for Redshift Dataset Definition input.
', 'refs' => [ 'DatasetDefinition$RedshiftDatasetDefinition' => NULL, ], ], 'RedshiftQueryString' => [ 'base' => 'The SQL query statements to be executed.
', 'refs' => [ 'RedshiftDatasetDefinition$QueryString' => NULL, ], ], 'RedshiftResultCompressionType' => [ 'base' => 'The compression used for Redshift query results.
', 'refs' => [ 'RedshiftDatasetDefinition$OutputCompression' => NULL, ], ], 'RedshiftResultFormat' => [ 'base' => 'The data storage format for Redshift query results.
', 'refs' => [ 'RedshiftDatasetDefinition$OutputFormat' => NULL, ], ], 'RedshiftUserName' => [ 'base' => 'The database user name used in Redshift query execution.
', 'refs' => [ 'RedshiftDatasetDefinition$DbUser' => NULL, ], ], 'RegisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterModelStepMetadata' => [ 'base' => 'Metadata for a register model job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$RegisterModel' => 'The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
', ], ], 'ReleaseNotes' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ReleaseNotes' => 'The maintainer description of the image version.
', 'DescribeImageVersionResponse$ReleaseNotes' => 'The maintainer description of the image version.
', 'UpdateImageVersionRequest$ReleaseNotes' => 'The maintainer description of the image version.
', ], ], 'RenderUiTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RenderUiTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenderableTask' => [ 'base' => 'Contains input values for a task.
', 'refs' => [ 'RenderUiTemplateRequest$Task' => 'A RenderableTask object containing a representative task to render.
A description of an error that occurred while rendering the template.
', 'refs' => [ 'RenderingErrorList$member' => NULL, ], ], 'RenderingErrorList' => [ 'base' => NULL, 'refs' => [ 'RenderUiTemplateResponse$Errors' => '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.
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.
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.
(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.
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.
', ], ], 'RepositoryUrl' => [ 'base' => NULL, 'refs' => [ 'CodeRepository$RepositoryUrl' => 'The URL of the Git repository.
', ], ], 'ResolvedAttributes' => [ 'base' => 'The resolved attributes.
', 'refs' => [ 'DescribeAutoMLJobResponse$ResolvedAttributes' => 'Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.
The Amazon Resource Name (ARN) of the resource that you want to tag.
', 'DeleteTagsInput$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource whose tags you want to delete.
', 'ListTagsInput$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
', ], ], 'ResourceCatalog' => [ 'base' => ' 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 Amazon Resource Name (ARN) of the ResourceCatalog.
A free form description of the ResourceCatalog.
A list of the requested ResourceCatalogs.
A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.
The name of the ResourceCatalog.
The value on which the resource catalog list is sorted.
', ], ], 'ResourceCatalogSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortOrder' => 'The order in which the resource catalogs are listed.
', ], ], 'ResourceConfig' => [ 'base' => 'Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.
', 'refs' => [ 'CreateTrainingJobRequest$ResourceConfig' => '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.
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
', 'HyperParameterTrainingJobDefinition$ResourceConfig' => '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.
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
', 'TrainingJobDefinition$ResourceConfig' => 'The resources, including the ML compute instances and ML storage volumes, to use for model training.
', ], ], 'ResourceConfigForUpdate' => [ 'base' => 'The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.
The training job ResourceConfig to update warm pool retention length.
The ID of the Amazon Elastic File System (EFS) managed by this Domain.
', ], ], 'ResourceInUse' => [ 'base' => 'Resource being accessed is in use.
', 'refs' => [], ], 'ResourceLimitExceeded' => [ 'base' => 'You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
', 'refs' => [], ], 'ResourceLimits' => [ 'base' => 'Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.
', 'refs' => [ 'HyperParameterTuningJobConfig$ResourceLimits' => 'The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.
', 'HyperParameterTuningJobSummary$ResourceLimits' => 'The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
', ], ], 'ResourceNotFound' => [ 'base' => 'Resource being access is not found.
', 'refs' => [], ], 'ResourcePolicyString' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyResponse$ResourcePolicy' => 'The resource policy that gives access to the lineage group in another account.
', ], ], 'ResourcePropertyName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => 'A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.
The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.
A suggested property name based on what you entered in the search textbox in the SageMaker console.
', 'SearchRequest$SortBy' => 'The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
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.
Specifies the ARN\'s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
', 'refs' => [ 'CreateAppRequest$ResourceSpec' => 'The instance type and the Amazon Resource Name (ARN) of the SageMaker 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.
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
', 'JupyterServerAppSettings$DefaultResourceSpec' => 'The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsRequest$Resource' => 'The name of the SageMaker resource to search for.
', 'SearchRequest$Resource' => 'The name of the SageMaker resource to search for.
', ], ], 'ResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'ResponseMIMETypes$member' => NULL, ], ], 'ResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedResponseMIMETypes' => 'The supported MIME types for the output data.
', 'InferenceSpecification$SupportedResponseMIMETypes' => 'The supported MIME types for the output data.
', ], ], 'RetentionPolicy' => [ 'base' => 'The retention policy for data stored on an Amazon Elastic File System (EFS) volume.
', 'refs' => [ 'DeleteDomainRequest$RetentionPolicy' => '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).
', ], ], 'RetentionType' => [ 'base' => NULL, 'refs' => [ 'RetentionPolicy$HomeEfsFileSystem' => 'The default is Retain, which specifies to keep the data stored on the EFS volume.
Specify Delete to delete the data stored on the EFS volume.
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.
The number of times to retry the job when the job fails due to an InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
The IAM roles that SageMaker uses to run the training jobs.
', 'CreateAutoMLJobRequest$RoleArn' => 'The ARN of the role that is used to access the data.
', 'CreateAutoMLJobV2Request$RoleArn' => 'The ARN of the role that is used to access the data.
', 'CreateCompilationJobRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
During model compilation, Amazon SageMaker 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, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateDeviceFleetRequest$RoleArn' => 'The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
', 'CreateEdgePackagingJobRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.
', 'CreateFeatureGroupRequest$RoleArn' => '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 role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'CreateInferenceExperimentRequest$RoleArn' => '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.
', 'CreateInferenceRecommendationsJobRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'CreateLabelingJobRequest$RoleArn' => '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.
', 'CreateModelBiasJobDefinitionRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateModelExplainabilityJobDefinitionRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateModelInput$ExecutionRoleArn' => '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.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateNotebookInstanceInput$RoleArn' => 'When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this 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.
The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
', 'CreateProcessingJobRequest$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'CreateTrainingJobRequest$RoleArn' => '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.
The ARN of the execution role for the space.
', 'DescribeAutoMLJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
', 'DescribeAutoMLJobV2Response$RoleArn' => 'The ARN of the Identity and Access Management role that has read permission to the input data location and write permission to the output data location in Amazon S3.
', 'DescribeCompilationJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
', 'DescribeDataQualityJobDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'DescribeDeviceFleetResponse$RoleArn' => 'The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
', 'DescribeEdgePackagingJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
', 'DescribeFeatureGroupResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
', 'DescribeFlowDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.
', 'DescribeImageResponse$RoleArn' => 'The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'DescribeInferenceExperimentResponse$RoleArn' => '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.
', 'DescribeInferenceRecommendationsJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.
', 'DescribeLabelingJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
', 'DescribeModelBiasJobDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
', 'DescribeModelExplainabilityJobDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
', 'DescribeModelOutput$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
', 'DescribeModelQualityJobDefinitionResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'DescribeNotebookInstanceOutput$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role associated with the instance.
', 'DescribePipelineResponse$RoleArn' => 'The Amazon Resource Name (ARN) that the pipeline uses to execute.
', 'DescribeProcessingJobResponse$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'DescribeTrainingJobResponse$RoleArn' => 'The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
', 'FeatureGroup$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
', 'HyperParameterTrainingJobDefinition$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
', 'InferenceExperimentSummary$RoleArn' => '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.
', 'InferenceRecommendationsJob$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'Model$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
', 'ModelPackageValidationSpecification$ValidationRole' => 'The IAM roles to be used for the validation of the model package.
', 'ModelRegisterSettings$CrossAccountModelRegisterRoleArn' => '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.
', 'MonitoringJobDefinition$RoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
', 'Pipeline$RoleArn' => 'The Amazon Resource Name (ARN) of the role that created the pipeline.
', 'PipelineSummary$RoleArn' => 'The Amazon Resource Name (ARN) that the pipeline used to execute.
', 'ProcessingJob$RoleArn' => 'The ARN of the role used to create the processing job.
', 'RStudioServerProDomainSettings$DomainExecutionRoleArn' => 'The ARN of the execution role for the RStudioServerPro Domain-level app.
The execution role for the RStudioServerPro Domain-level app.
The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
', 'RenderUiTemplateRequest$RoleArn' => 'The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
', 'TimeSeriesForecastingSettings$AmazonForecastRoleArn' => '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.
The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
', 'UpdateDeviceFleetRequest$RoleArn' => 'The Amazon Resource Name (ARN) of the device.
', 'UpdateImageRequest$RoleArn' => 'The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
', 'UpdateNotebookInstanceInput$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. 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.
The Amazon Resource Name (ARN) that the pipeline uses to execute.
', 'UserSettings$ExecutionRole' => 'The execution role for the user.
', ], ], 'RollingUpdatePolicy' => [ 'base' => 'Specifies a rolling deployment strategy for updating a SageMaker endpoint.
', 'refs' => [ 'DeploymentConfig$RollingUpdatePolicy' => 'Specifies a rolling deployment strategy for updating a SageMaker endpoint.
', ], ], 'RootAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$RootAccess' => 'Whether 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.
Whether 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.
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 name of the rule configuration. It must be unique relative to other rule configuration names.
', 'DebugRuleEvaluationStatus$RuleConfigurationName' => 'The name of the rule configuration.
', 'ProfilerRuleConfiguration$RuleConfigurationName' => 'The name of the rule configuration. It must be unique relative to other rule configuration names.
', 'ProfilerRuleEvaluationStatus$RuleConfigurationName' => 'The name of the rule configuration.
', ], ], 'RuleEvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$RuleEvaluationStatus' => 'Status of the rule evaluation.
', 'ProfilerRuleEvaluationStatus$RuleEvaluationStatus' => 'Status of the rule evaluation.
', ], ], 'RuleParameters' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleParameters' => 'Runtime configuration for rule container.
', 'ProfilerRuleConfiguration$RuleParameters' => 'Runtime configuration for rule container.
', ], ], 'S3DataDistribution' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataDistributionType' => '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.
Describes the S3 data source.
Your input bucket must be in the same Amazon Web Services region as your training job.
', 'refs' => [ 'DataSource$S3DataSource' => 'The S3 location of the data source that is associated with a channel.
', ], ], 'S3DataType' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataType' => '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.
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
Specifies the S3 location of ML model data to deploy.
', 'refs' => [ 'ModelDataSource$S3DataSource' => 'Specifies the S3 location of ML model data to deploy.
', ], ], 'S3ModelDataType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3DataType' => '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 the S3 path of ML model data to deploy.
', ], ], 'S3OutputPath' => [ 'base' => NULL, 'refs' => [ 'HubS3StorageConfig$S3OutputPath' => 'The Amazon S3 bucket prefix for hosting hub content.
', ], ], 'S3StorageConfig' => [ 'base' => 'The Amazon Simple Storage (Amazon S3) location and and security configuration for OfflineStore.
The Amazon Simple Storage (Amazon S3) location of OfflineStore.
The location in Amazon S3 where Athena query results are stored.
', 'AutoMLCandidateGenerationConfig$FeatureSpecificationS3Uri' => '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.
The Amazon S3 output path. Must be 128 characters or less.
', 'AutoMLS3DataSource$S3Uri' => 'The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.
', 'BatchDataCaptureConfig$DestinationS3Uri' => 'The Amazon S3 location being used to capture the data.
', 'CheckpointConfig$S3Uri' => 'Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
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.
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.
', 'DataQualityAppSpecification$RecordPreprocessorSourceUri' => '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 flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
', 'DataQualityAppSpecification$PostAnalyticsProcessorSourceUri' => 'An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
', 'DebugHookConfig$S3OutputPath' => 'Path to Amazon S3 storage location for metrics and tensors.
', 'DebugRuleConfiguration$S3OutputPath' => 'Path to Amazon S3 storage location for rules.
', 'DescribeEdgePackagingJobResponse$ModelArtifact' => 'The Amazon Simple Storage (S3) URI where model artifacts ares stored.
', 'DescribeLabelingJobResponse$LabelCategoryConfigS3Uri' => '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"
}
]
}
The Amazon Simple Storage (S3) bucker URI.
', 'FileSource$S3Uri' => 'The Amazon S3 URI for the file source.
', 'FlowDefinitionOutputConfig$S3OutputPath' => '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.
', 'InferenceRecommendationsJob$SamplePayloadUrl' => '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).
', 'InputConfig$S3Uri' => '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).
', 'LabelingJobOutput$OutputDatasetS3Uri' => 'The Amazon S3 bucket location of the manifest file for labeled data.
', 'LabelingJobOutputConfig$S3OutputPath' => 'The Amazon S3 location to write output data.
', 'LabelingJobS3DataSource$ManifestS3Uri' => '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.
', 'MetricsSource$S3Uri' => 'The S3 URI for the metrics source.
', 'ModelArtifacts$S3ModelArtifacts' => 'The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.
JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.
', 'ModelCardExportArtifacts$S3ExportArtifacts' => 'The Amazon S3 URI of the exported model artifacts.
', 'ModelCardExportOutputConfig$S3OutputPath' => 'The Amazon S3 output path to export your model card PDF.
', 'ModelExplainabilityAppSpecification$ConfigUri' => 'JSON formatted S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.
', 'ModelQualityAppSpecification$RecordPreprocessorSourceUri' => '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 flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
', 'ModelQualityAppSpecification$PostAnalyticsProcessorSourceUri' => 'An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
', 'MonitoringAppSpecification$RecordPreprocessorSourceUri' => '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 flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
', 'MonitoringAppSpecification$PostAnalyticsProcessorSourceUri' => 'An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
', 'MonitoringConstraintsResource$S3Uri' => 'The Amazon S3 URI for the constraints resource.
', 'MonitoringStatisticsResource$S3Uri' => 'The Amazon S3 URI for the statistics resource.
', 'OutputConfig$S3OutputLocation' => 'Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For 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 URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
', 'ProcessingS3Output$S3Uri' => 'A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
', 'ProfilerConfig$S3OutputPath' => 'Path to Amazon S3 storage location for system and framework metrics.
', 'ProfilerConfigForUpdate$S3OutputPath' => 'Path to Amazon S3 storage location for system and framework metrics.
', 'ProfilerRuleConfiguration$S3OutputPath' => 'Path to Amazon S3 storage location for rules.
', 'RecommendationJobCompiledOutputConfig$S3OutputUri' => 'Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.
', 'RedshiftDatasetDefinition$OutputS3Uri' => 'The location in Amazon S3 where the Redshift query results are stored.
', 'S3DataSource$S3Uri' => '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.
', 'S3StorageConfig$S3Uri' => 'The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following: s3://example-bucket/prefix/.
The S3 path where offline records are written.
', 'SharingSettings$S3OutputPath' => 'When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
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.
Path to Amazon S3 storage location for TensorBoard output.
', 'TimeSeriesForecastingJobConfig$FeatureSpecificationS3Uri' => '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 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.
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 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.
', 'WorkspaceSettings$S3ArtifactPath' => '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.
', ], ], 'SageMakerImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'DeleteImageVersionRequest$Alias' => 'The alias of the image to delete.
', 'DescribeImageVersionRequest$Alias' => 'The alias of the image version.
', 'ListAliasesRequest$Alias' => 'The alias of the image version.
', 'SageMakerImageVersionAliases$member' => NULL, 'UpdateImageVersionRequest$Alias' => 'The alias of the image version.
', ], ], 'SageMakerImageVersionAliases' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Aliases' => 'A list of aliases created with the image version.
', 'ListAliasesResponse$SageMakerImageVersionAliases' => 'A list of SageMaker image version aliases.
', 'UpdateImageVersionRequest$AliasesToAdd' => 'A list of aliases to add.
', 'UpdateImageVersionRequest$AliasesToDelete' => 'A list of aliases to delete.
', ], ], 'SagemakerServicecatalogStatus' => [ 'base' => NULL, 'refs' => [ 'GetSagemakerServicecatalogPortfolioStatusOutput$Status' => 'Whether Service Catalog is enabled or disabled in SageMaker.
', ], ], 'SampleWeightAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$SampleWeightAttributeName' => '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.
', 'TabularJobConfig$SampleWeightAttributeName' => '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.
', ], ], 'SamplingPercentage' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$InitialSamplingPercentage' => 'The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.
', 'DataCaptureConfigSummary$CurrentSamplingPercentage' => 'The percentage of requests being captured by your Endpoint.
', ], ], 'ScalingPolicies' => [ 'base' => NULL, 'refs' => [ 'DynamicScalingConfiguration$ScalingPolicies' => 'An object of the scaling policies for each metric.
', ], ], 'ScalingPolicy' => [ 'base' => 'An object containing a recommended scaling policy.
', 'refs' => [ 'ScalingPolicies$member' => NULL, ], ], 'ScalingPolicyMetric' => [ 'base' => 'The metric for a scaling policy.
', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$Metric' => 'An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.
', ], ], 'ScalingPolicyObjective' => [ 'base' => 'An object where you specify the anticipated traffic pattern for an endpoint.
', 'refs' => [ 'GetScalingConfigurationRecommendationRequest$ScalingPolicyObjective' => 'An object where you specify the anticipated traffic pattern for an endpoint.
', 'GetScalingConfigurationRecommendationResponse$ScalingPolicyObjective' => 'An object representing the anticipated traffic pattern for an endpoint that you specified in the request.
', ], ], 'ScheduleConfig' => [ 'base' => 'Configuration details about the monitoring schedule.
', 'refs' => [ 'MonitoringScheduleConfig$ScheduleConfig' => 'Configures the monitoring schedule.
', ], ], 'ScheduleExpression' => [ 'base' => NULL, 'refs' => [ 'ScheduleConfig$ScheduleExpression' => 'A cron expression that describes details about the monitoring schedule.
Currently the only supported cron expressions are:
If you want to set the job to start every hour, please use the following:
Hourly: cron(0 * ? * * *)
If you want to start the job daily:
cron(0 [00-23] ? * * *)
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 will pick a time for running every day.
The status of an monitoring job.
', 'ListMonitoringSchedulesRequest$StatusEquals' => 'A filter that returns only monitoring schedules modified before a specified time.
', 'ModelDashboardMonitoringSchedule$MonitoringScheduleStatus' => 'The status of the monitoring schedule.
', 'MonitoringSchedule$MonitoringScheduleStatus' => '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.
The status of the monitoring schedule.
', ], ], 'SearchExpression' => [ 'base' => '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 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.
A list of search expression objects.
', ], ], 'SearchRecord' => [ 'base' => 'A single resource returned as part of the Search API response.
', 'refs' => [ 'SearchResultsList$member' => NULL, ], ], 'SearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchResultsList' => [ 'base' => NULL, 'refs' => [ 'SearchResponse$Results' => 'A list of SearchRecord objects.
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
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
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
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
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.
A history of all of the secondary statuses that the training job has transitioned through.
', 'TrainingJob$SecondaryStatusTransitions' => 'A history of all of the secondary statuses that the training job has transitioned through.
', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'GitConfig$SecretArn' => '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}
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}
The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
', 'DefaultSpaceSettings$SecurityGroups' => 'The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.
', 'DescribeNotebookInstanceOutput$SecurityGroups' => 'The IDs of the VPC security groups.
', 'UserSettings$SecurityGroups' => 'The security groups for the Amazon Virtual Private Cloud (VPC) that Studio 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 adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
', ], ], 'Seed' => [ 'base' => NULL, 'refs' => [ 'ShuffleConfig$Seed' => 'Determines the shuffling order in ShuffleConfig value.
A step selected to run in selective execution mode.
', 'refs' => [ 'SelectedStepList$member' => NULL, ], ], 'SelectedStepList' => [ 'base' => NULL, 'refs' => [ 'SelectiveExecutionConfig$SelectedSteps' => 'A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.
', ], ], 'SelectiveExecutionConfig' => [ 'base' => 'The selective execution configuration applied to the pipeline run.
', 'refs' => [ 'DescribePipelineExecutionResponse$SelectiveExecutionConfig' => 'The selective execution configuration applied to the pipeline run.
', 'PipelineExecution$SelectiveExecutionConfig' => 'The selective execution configuration applied to the pipeline run.
', 'StartPipelineExecutionRequest$SelectiveExecutionConfig' => 'The selective execution configuration applied to the pipeline run.
', ], ], 'SelectiveExecutionResult' => [ 'base' => 'The ARN from an execution of the current pipeline.
', 'refs' => [ 'PipelineExecutionStep$SelectiveExecutionResult' => 'The ARN from an execution of the current pipeline from which results are reused for this step.
', ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepFailureResponse' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerlessMaxConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MaxConcurrency' => 'The maximum number of concurrent invocations your serverless endpoint can process.
', 'ProductionVariantServerlessUpdateConfig$MaxConcurrency' => 'The updated maximum number of concurrent invocations your serverless endpoint can process.
', ], ], 'ServerlessMemorySizeInMB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MemorySizeInMB' => 'The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.
', ], ], 'ServerlessProvisionedConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$ProvisionedConcurrency' => 'The 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. Should be less than or equal to MaxConcurrency.
The ID of the provisioned product.
', 'ServiceCatalogProvisioningDetails$ProductId' => 'The ID of the product to provision.
', 'ServiceCatalogProvisioningDetails$ProvisioningArtifactId' => 'The ID of the provisioning artifact.
', 'ServiceCatalogProvisioningDetails$PathId' => 'The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningArtifactId' => 'The ID of the provisioning artifact.
', ], ], 'ServiceCatalogProvisionedProductDetails' => [ 'base' => 'Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
', 'refs' => [ 'DescribeProjectOutput$ServiceCatalogProvisionedProductDetails' => 'Information about a provisioned service catalog product.
', 'Project$ServiceCatalogProvisionedProductDetails' => NULL, ], ], 'ServiceCatalogProvisioningDetails' => [ 'base' => 'Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
', 'refs' => [ 'CreateProjectInput$ServiceCatalogProvisioningDetails' => '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.
', 'DescribeProjectOutput$ServiceCatalogProvisioningDetails' => 'Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.
', 'Project$ServiceCatalogProvisioningDetails' => NULL, ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'base' => 'Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
', 'refs' => [ 'UpdateProjectInput$ServiceCatalogProvisioningUpdateDetails' => '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.
', ], ], 'SessionExpirationDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$SessionExpirationDurationInSeconds' => 'The session expiration duration in seconds. This value defaults to 43200.
', 'CreatePresignedNotebookInstanceUrlInput$SessionExpirationDurationInSeconds' => 'The duration of the session, in seconds. The default is 12 hours.
', ], ], 'ShadowModeConfig' => [ 'base' => ' 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.
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 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.
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 name and sampling percentage of a shadow variant.
', 'refs' => [ 'ShadowModelVariantConfigList$member' => NULL, ], ], 'ShadowModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'ShadowModeConfig$ShadowModelVariants' => 'List of shadow variant configurations.
', ], ], 'SharingSettings' => [ 'base' => 'Specifies options for sharing SageMaker 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.
Specifies options for sharing SageMaker Studio notebooks.
', ], ], 'ShuffleConfig' => [ 'base' => '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.
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.
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.
', 'DescribeUserProfileResponse$SingleSignOnUserIdentifier' => 'The IAM Identity Center user identifier.
', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$SuccessTopic' => 'Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.
', 'AsyncInferenceNotificationConfig$ErrorTopic' => 'Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.
', 'LabelingJobOutputConfig$SnsTopicArn' => '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.
', 'LabelingJobSnsDataSource$SnsTopicArn' => '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.
', ], ], 'SortActionsBy' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortBy' => 'The property used to sort results. The default value is CreationTime.
The property used to sort results. The default value is CreationTime.
The property used to sort results. The default value is CreationTime.
The field to sort results by. The default is CreationTime.
The field to sort results by. The default is CreationTime.
The field to sort results by. The default is CreationTime.
The field to sort results by. The default is CreationTime.
The property used to sort results. The default value is CreationTime.
The property used to sort results. The default value is CreationTime.
The column by which to sort the listed inference experiments.
', ], ], 'SortLineageGroupsBy' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsRequest$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
The sort order. The default value is Descending.
The sort order for the results. The default is Ascending.
The sort order. The default value is Descending.
The sort order for the results. The default is Ascending.
', 'ListArtifactsRequest$SortOrder' => 'The sort order. The default value is Descending.
The sort order. The default value is Descending.
The sort order for results. The default is Ascending.
The sort order. The default value is Descending.
The sort order for results. The default is Descending.
What direction to sort in.
', 'ListEdgeDeploymentPlansRequest$SortOrder' => 'The direction of the sorting (ascending or descending).
', 'ListEdgePackagingJobsRequest$SortOrder' => 'What direction to sort by.
', 'ListExperimentsRequest$SortOrder' => 'The sort order. The default value is Descending.
An optional value that specifies whether you want the results sorted in Ascending or Descending order.
Sort hub content versions by ascending or descending order.
', 'ListHubContentsRequest$SortOrder' => 'Sort hubs by ascending or descending order.
', 'ListHubsRequest$SortOrder' => 'Sort hubs by ascending or descending order.
', 'ListHumanTaskUisRequest$SortOrder' => 'An optional value that specifies whether you want the results sorted in Ascending or Descending order.
The sort order for results. The default is Ascending.
The direction of sorting (ascending or descending).
', 'ListInferenceRecommendationsJobsRequest$SortOrder' => 'The sort order for the results.
', 'ListLabelingJobsForWorkteamRequest$SortOrder' => 'The sort order for results. The default is Ascending.
The sort order for results. The default is Ascending.
The sort order for the results. The default is Ascending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The sort order for results. The default is Ascending.
The sort order for the results. The default is Ascending.
The sort order for results. The default is Descending.
The sort order, whether Ascending or Descending, of the alert history. The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The field by which to sort results. The default is CreatedTime.
The sort order for results.
', 'ListPipelinesRequest$SortOrder' => 'The sort order for results.
', 'ListProcessingJobsRequest$SortOrder' => 'The sort order for results. The default is Ascending.
The sort order for the results. The default is Ascending.
The sort order. The default value is Descending.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$SortOrder' => 'The sort order for results. The default is Ascending.
The sort order for results. The default is Ascending.
The sort order for results. The default is Descending.
The sort order. The default value is Descending.
The sort order. The default value is Descending.
The sort order for the results. The default is Ascending.
', 'ListWorkforcesRequest$SortOrder' => 'Sort workforces in ascending or descending order.
', 'ListWorkteamsRequest$SortOrder' => 'The sort order for results. The default is Ascending.
The field by which to sort results. The default is CreatedTime.
The field by which to sort results. The default is CreatedTime.
The property used to sort results. The default value is CreationTime.
The property used to sort results. The default value is CreationTime.
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.
', 'refs' => [ 'SourceAlgorithmList$member' => NULL, ], ], 'SourceAlgorithmList' => [ 'base' => NULL, 'refs' => [ 'SourceAlgorithmSpecification$SourceAlgorithms' => 'A list of the algorithms that were used to create a model package.
', ], ], 'SourceAlgorithmSpecification' => [ 'base' => 'A list of algorithms that were used to create a model package.
', 'refs' => [ 'CreateModelPackageInput$SourceAlgorithmSpecification' => 'Details about the algorithm that was used to create the model package.
', 'DescribeModelPackageOutput$SourceAlgorithmSpecification' => 'Details about the algorithm that was used to create the model package.
', 'ModelPackage$SourceAlgorithmSpecification' => 'A list of algorithms that were used to create a model package.
', ], ], 'SourceIpConfig' => [ 'base' => '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 login to their worker portal from an IP address within this range. By default, a workforce isn\'t restricted to specific IP addresses.
', 'refs' => [ 'CreateWorkforceRequest$SourceIpConfig' => NULL, 'UpdateWorkforceRequest$SourceIpConfig' => '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
', 'Workforce$SourceIpConfig' => '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.
', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceType' => 'The source type.
', 'TrialComponentSource$SourceType' => 'The source job type.
', 'TrialSource$SourceType' => 'The source job type.
', ], ], 'SourceUri' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SourceUri' => 'A filter that returns only actions with the specified source URI.
', 'ListArtifactsRequest$SourceUri' => 'A filter that returns only artifacts with the specified source URI.
', 'ListContextsRequest$SourceUri' => 'A filter that returns only contexts with the specified source URI.
', ], ], 'SpaceArn' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceResponse$SpaceArn' => 'The space\'s Amazon Resource Name (ARN).
', 'DescribeSpaceResponse$SpaceArn' => 'The space\'s Amazon Resource Name (ARN).
', 'UpdateSpaceResponse$SpaceArn' => 'The space\'s Amazon Resource Name (ARN).
', ], ], 'SpaceDetails' => [ 'base' => 'The space\'s details.
', 'refs' => [ 'SpaceList$member' => NULL, ], ], 'SpaceList' => [ 'base' => NULL, 'refs' => [ 'ListSpacesResponse$Spaces' => 'The list of spaces.
', ], ], 'SpaceName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$SpaceName' => 'The name of the space.
', 'CreateAppRequest$SpaceName' => 'The name of the space. If this value is not set, then UserProfileName must be set.
The name of the space.
', 'CreateSpaceRequest$SpaceName' => 'The name of the space.
', 'DeleteAppRequest$SpaceName' => 'The name of the space. If this value is not set, then UserProfileName must be set.
The name of the space.
', 'DescribeAppRequest$SpaceName' => 'The name of the space.
', 'DescribeAppResponse$SpaceName' => 'The name of the space. If this value is not set, then UserProfileName must be set.
The name of the space.
', 'DescribeSpaceResponse$SpaceName' => 'The name of the space.
', 'ListAppsRequest$SpaceNameEquals' => 'A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.
A parameter by which to filter the results.
', 'SpaceDetails$SpaceName' => 'The name of the space.
', 'UpdateSpaceRequest$SpaceName' => 'The name of the space.
', ], ], 'SpaceSettings' => [ 'base' => 'A collection of space settings.
', 'refs' => [ 'CreateSpaceRequest$SpaceSettings' => 'A collection of space settings.
', 'DescribeSpaceResponse$SpaceSettings' => 'A collection of space settings.
', 'UpdateSpaceRequest$SpaceSettings' => 'A collection of space settings.
', ], ], 'SpaceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListSpacesRequest$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
The status.
', 'SpaceDetails$Status' => 'The status.
', ], ], 'SpawnRate' => [ 'base' => NULL, 'refs' => [ 'Phase$SpawnRate' => 'Specified how many new users to spawn in a minute.
', ], ], 'SplitType' => [ 'base' => NULL, 'refs' => [ 'TransformInput$SplitType' => '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.
The general status of the current stage.
', ], ], 'Stairs' => [ 'base' => '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.
', 'refs' => [ 'TrafficPattern$Stairs' => 'Defines the stairs traffic pattern.
', ], ], 'StartEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Statistic' => 'The statistic of the customized metric.
', ], ], 'StatusDetails' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$StatusDetails' => 'Details from the rule evaluation.
', 'ProfilerRuleEvaluationStatus$StatusDetails' => 'Details from the rule evaluation.
', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'SecondaryStatusTransition$StatusMessage' => '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.
Downloading the training image.
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
The description of the step.
', ], ], 'StepDisplayName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDisplayName' => 'The display name of the step.
', ], ], 'StepName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepName' => 'The name of the step that is executed.
', ], ], 'StepStatus' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepStatus' => 'The status of the step execution.
', ], ], 'StopAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StoppingCondition' => [ 'base' => 'Specifies a limit to how long a model training job or model compilation 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 or compilation job. Use this API to cap model training 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.
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
', 'CreateTrainingJobRequest$StoppingCondition' => '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.
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
', 'DescribeTrainingJobResponse$StoppingCondition' => '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.
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.
', 'TrainingJob$StoppingCondition' => '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.
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.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$FailureReason' => 'if the overall status is Failed, the reason for the failure.
The attributes of the input data that are the input features.
', 'BatchTransformInput$InferenceAttribute' => 'The attribute of the input data that represents the ground truth label.
', 'BatchTransformInput$ProbabilityAttribute' => 'In a classification problem, the attribute that represents the class probability.
', 'CreateModelPackageInput$Domain' => 'The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
', 'CreateModelPackageInput$Task' => '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.
', 'CustomizedMetricSpecification$MetricName' => 'The name of the customized metric.
', 'CustomizedMetricSpecification$Namespace' => 'The namespace of the customized metric.
', 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatusMessage' => 'Returns a message describing the job status and error messages.
', 'DescribeEdgePackagingJobResponse$ModelSignature' => 'The signature document of files in the model artifact.
', 'DescribeModelPackageOutput$Domain' => 'The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
', 'DescribeModelPackageOutput$Task' => 'The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
', 'DescribeModelPackageOutput$SamplePayloadUrl' => '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).
', 'DeviceDeploymentSummary$DeviceDeploymentStatusMessage' => 'The detailed error message for the deployoment status result.
', 'EdgeDeploymentStatus$EdgeDeploymentStatusMessage' => 'A detailed message about deployment status in current stage.
', 'EdgeOutputConfig$PresetDeploymentConfig' => 'The 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.
Returns a message describing the status of the deployed resource.
', 'EndpointInput$FeaturesAttribute' => 'The attributes of the input data that are the input features.
', 'EndpointInput$InferenceAttribute' => 'The attribute of the input data that represents the ground truth label.
', 'EndpointInput$ProbabilityAttribute' => 'In a classification problem, the attribute that represents the class probability.
', 'EndpointOutputConfiguration$EndpointName' => 'The name of the endpoint made during a recommendation job.
', 'EndpointOutputConfiguration$VariantName' => 'The name of the production variant (deployed model) made during a recommendation job.
', 'EnvironmentParameter$Key' => 'The environment key suggested by the Amazon SageMaker Inference Recommender.
', 'EnvironmentParameter$ValueType' => 'The value type suggested by the Amazon SageMaker Inference Recommender.
', 'EnvironmentParameter$Value' => 'The value suggested by the Amazon SageMaker Inference Recommender.
', 'GetScalingConfigurationRecommendationRequest$RecommendationId' => '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 recommendation ID of a previously completed inference recommendation.
', 'IamIdentity$Arn' => 'The Amazon Resource Name (ARN) of the IAM identity.
', 'IamIdentity$PrincipalId' => 'The ID of the principal that assumes the IAM identity.
', 'IamIdentity$SourceIdentity' => 'The person or application which assumes the IAM identity.
', 'InferenceRecommendation$RecommendationId' => 'The recommendation ID which uniquely identifies each recommendation.
', 'ListProcessingJobsRequest$NameContains' => 'A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.
', 'ModelCard$ModelId' => 'The unique name (ID) of the model.
', 'ModelCard$RiskRating' => 'The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
', 'ModelCard$ModelPackageGroupName' => 'The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
', 'ModelDashboardModelCard$ModelId' => 'For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.
', 'ModelDashboardModelCard$RiskRating' => 'A model card\'s risk rating. Can be low, medium, or high.
', 'ModelMetadataSummary$Domain' => 'The machine learning domain of the model.
', 'ModelMetadataSummary$Framework' => 'The machine learning framework of the model.
', 'ModelMetadataSummary$Task' => 'The machine learning task of the model.
', 'ModelMetadataSummary$Model' => 'The name of the model.
', 'ModelMetadataSummary$FrameworkVersion' => 'The framework version of the model.
', 'ModelPackage$Domain' => 'The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
', 'ModelPackage$Task' => 'The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
', 'ModelPackage$SamplePayloadUrl' => '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).
', 'ModelPackageContainerDefinition$Framework' => 'The machine learning framework of the model package container image.
', 'ModelPackageContainerDefinition$NearestModelName' => '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.
if the overall status is Failed, the reason for the failure.
The metric type. You can only apply SageMaker metric types to SageMaker endpoints.
', 'ProcessingInput$InputName' => 'The name for the processing job input.
', 'ProcessingOutput$OutputName' => 'The name for the processing job output.
', 'ProductListings$member' => NULL, 'RStudioServerProDomainSettings$RStudioConnectUrl' => 'A URL pointing to an RStudio Connect server.
', 'RStudioServerProDomainSettings$RStudioPackageManagerUrl' => 'A URL pointing to an RStudio Package Manager server.
', 'RStudioServerProDomainSettingsForUpdate$RStudioConnectUrl' => 'A URL pointing to an RStudio Connect server.
', 'RStudioServerProDomainSettingsForUpdate$RStudioPackageManagerUrl' => 'A URL pointing to an RStudio Package Manager server.
', 'RealTimeInferenceRecommendation$RecommendationId' => 'The recommendation ID which uniquely identifies each recommendation.
', 'RecommendationJobContainerConfig$Domain' => '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.
Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER
The machine learning framework of the container image.
Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN
The framework version of the container image.
', 'RecommendationJobContainerConfig$NearestModelName' => '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 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).
', 'RecommendationJobSupportedContentTypes$member' => NULL, 'RecommendationJobSupportedInstanceTypes$member' => NULL, 'RenderUiTemplateResponse$RenderedContent' => 'A Liquid template that renders the HTML for the worker UI.
', 'RenderingError$Code' => 'A unique identifier for a specific class of errors.
', 'RenderingError$Message' => 'A human-readable message describing the error.
', 'SubscribedWorkteam$SellerName' => 'The name of the vendor in the Amazon Marketplace.
', 'SubscribedWorkteam$ListingId' => 'Marketplace product listing ID.
', 'UserContext$UserProfileArn' => 'The Amazon Resource Name (ARN) of the user\'s profile.
', 'UserContext$UserProfileName' => 'The name of the user\'s profile.
', 'UserContext$DomainId' => 'The domain associated with the user.
', 'Workforce$SubDomain' => 'The subdomain for your OIDC Identity Provider.
', 'Workteam$SubDomain' => 'The URI of the labeling job\'s user interface. Workers open this URI to start labeling your data objects.
', ], ], 'String1024' => [ 'base' => NULL, 'refs' => [ 'ClarifyCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => 'The Amazon S3 URI of baseline constraints file to be used for the drift check.
', 'ClarifyCheckStepMetadata$CalculatedBaselineConstraints' => 'The Amazon S3 URI of the newly calculated baseline constraints file.
', 'ClarifyCheckStepMetadata$ViolationReport' => 'The Amazon S3 URI of the violation report if violations are detected.
', 'CreateDomainResponse$Url' => 'The URL to the created domain.
', 'DescribeDomainResponse$Url' => 'The domain\'s URL.
', 'DomainDetails$Url' => 'The domain\'s URL.
', 'EMRStepMetadata$LogFilePath' => 'The path to the log file where the cluster step\'s failure root cause is recorded.
', 'OutputParameter$Value' => 'The value of the output parameter.
', 'Parameter$Value' => 'The literal value for the parameter.
', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckStatistics' => 'The Amazon S3 URI of the baseline statistics file used for the drift check.
', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => 'The Amazon S3 URI of the baseline constraints file used for the drift check.
', 'QualityCheckStepMetadata$CalculatedBaselineStatistics' => 'The Amazon S3 URI of the newly calculated baseline statistics file.
', 'QualityCheckStepMetadata$CalculatedBaselineConstraints' => 'The Amazon S3 URI of the newly calculated baseline constraints file.
', 'QualityCheckStepMetadata$ViolationReport' => 'The Amazon S3 URI of violation report if violations are detected.
', ], ], 'String128' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRangeValues$member' => NULL, ], ], 'String200' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$Description' => 'A description of the work team.
', 'SubscribedWorkteam$MarketplaceTitle' => 'The title of the service provided by the vendor in the Amazon Marketplace.
', 'SubscribedWorkteam$MarketplaceDescription' => 'The description of the vendor from the Amazon Marketplace.
', 'UpdateWorkteamRequest$Description' => 'An updated description for the work team.
', 'Workteam$Description' => 'A description of the work team.
', ], ], 'String2048' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceUri' => 'The URI of the source.
', 'ArtifactSource$SourceUri' => 'The URI of the source.
', 'ContextSource$SourceUri' => 'The URI of the source.
', ], ], 'String256' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceType' => 'The type of the source.
', 'ActionSource$SourceId' => 'The ID of the source.
', 'ArtifactSourceType$Value' => 'The ID.
', 'ArtifactSummary$ArtifactType' => 'The type of the artifact.
', 'AssociationSummary$SourceType' => 'The source type.
', 'AssociationSummary$DestinationType' => 'The destination type.
', 'CallbackStepMetadata$SqsQueueUrl' => 'The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.
', 'ClarifyCheckStepMetadata$CheckType' => 'The type of the Clarify Check step
', 'ClarifyCheckStepMetadata$ModelPackageGroupName' => 'The model package group name.
', 'ClarifyCheckStepMetadata$CheckJobArn' => 'The Amazon Resource Name (ARN) of the check processing job that was run by this step\'s execution.
', 'ContextSource$SourceType' => 'The type of the source.
', 'ContextSource$SourceId' => 'The ID of the source.
', 'ContextSummary$ContextType' => 'The type of the context.
', 'CreateActionRequest$ActionType' => 'The action type.
', 'CreateArtifactRequest$ArtifactType' => 'The artifact type.
', 'CreateContextRequest$ContextType' => 'The context type.
', 'CreateUserProfileRequest$SingleSignOnUserValue' => '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.
', 'DescribeActionResponse$ActionType' => 'The type of the action.
', 'DescribeArtifactResponse$ArtifactType' => 'The type of the artifact.
', 'DescribeContextResponse$ContextType' => 'The type of the context.
', 'DescribeDomainResponse$SingleSignOnManagedApplicationInstanceId' => 'The IAM Identity Center managed application instance ID.
', 'DescribeUserProfileResponse$SingleSignOnUserValue' => 'The IAM Identity Center user value.
', 'EMRStepMetadata$ClusterId' => 'The identifier of the EMR cluster.
', 'EMRStepMetadata$StepId' => 'The identifier of the EMR cluster step.
', 'EMRStepMetadata$StepName' => 'The name of the EMR cluster step.
', 'LambdaStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.
', 'ListActionsRequest$ActionType' => 'A filter that returns only actions of the specified type.
', 'ListArtifactsRequest$ArtifactType' => 'A filter that returns only artifacts of the specified type.
', 'ListAssociationsRequest$SourceType' => 'A filter that returns only associations with the specified source type.
', 'ListAssociationsRequest$DestinationType' => 'A filter that returns only associations with the specified destination type.
', 'ListContextsRequest$ContextType' => 'A filter that returns only contexts of the specified type.
', 'ListTrialComponentsRequest$SourceArn' => '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 value to filter the model metadata.
', 'ModelStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the created model.
', 'OutputParameter$Name' => 'The name of the output parameter.
', 'QualityCheckStepMetadata$CheckType' => 'The type of the Quality check step.
', 'QualityCheckStepMetadata$ModelPackageGroupName' => 'The model package group name.
', 'QualityCheckStepMetadata$CheckJobArn' => 'The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
', 'QueryProperties$key' => NULL, 'QueryProperties$value' => NULL, 'RegisterModelStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the model package.
', 'SelectedStep$StepName' => 'The name of the pipeline step.
', 'SendPipelineExecutionStepFailureRequest$FailureReason' => 'A message describing why the step failed.
', ], ], 'String3072' => [ 'base' => NULL, 'refs' => [ 'FailStepMetadata$ErrorMessage' => 'A message that you define and then is processed and rendered by the Fail step when the error occurs.
', 'PipelineExecutionSummary$PipelineExecutionFailureReason' => 'A message generated by SageMaker Pipelines describing why the pipeline execution failed.
', ], ], 'String40' => [ 'base' => NULL, 'refs' => [ 'QueryTypes$member' => NULL, 'Vertex$Type' => 'The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...
The type of the action.
', 'CategoricalParameter$Name' => 'The Name of the environment variable.
', 'ModelLatencyThreshold$Percentile' => 'The model latency percentile threshold. For custom load tests, specify the value as P95.
Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.
Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.
The string value of a categorical hyperparameter. If you specify a value for this parameter, you can\'t specify the NumberValue parameter.
The App type that the Lifecycle Configuration is attached to.
', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigAppType' => 'The App type that the Lifecycle Configuration is attached to.
', 'ListStudioLifecycleConfigsRequest$AppTypeEquals' => 'A parameter to search for the App Type to which the Lifecycle Configuration is attached.
', 'StudioLifecycleConfigDetails$StudioLifecycleConfigAppType' => 'The App type to which the Lifecycle Configuration is attached.
', ], ], 'StudioLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => 'The ARN of your created Lifecycle Configuration.
', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => 'The ARN of the Lifecycle Configuration to describe.
', 'LifecycleConfigArns$member' => NULL, 'ResourceSpec$LifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
', 'StudioLifecycleConfigDetails$StudioLifecycleConfigArn' => 'The Amazon Resource Name (ARN) of the Lifecycle Configuration.
', ], ], 'StudioLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigContent' => 'The content of your Studio Lifecycle Configuration script. This content must be base64 encoded.
', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigContent' => 'The content of your Studio Lifecycle Configuration script.
', ], ], 'StudioLifecycleConfigDetails' => [ 'base' => 'Details of the Studio Lifecycle Configuration.
', 'refs' => [ 'StudioLifecycleConfigsList$member' => NULL, ], ], 'StudioLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration to create.
', 'DeleteStudioLifecycleConfigRequest$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration to delete.
', 'DescribeStudioLifecycleConfigRequest$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration to describe.
', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration that is described.
', 'ListStudioLifecycleConfigsRequest$NameContains' => 'A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.
', 'StudioLifecycleConfigDetails$StudioLifecycleConfigName' => 'The name of the Studio Lifecycle Configuration.
', ], ], 'StudioLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsRequest$SortBy' => 'The property used to sort results. The default value is CreationTime.
', ], ], 'StudioLifecycleConfigsList' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsResponse$StudioLifecycleConfigs' => 'A list of Lifecycle Configurations and their properties.
', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SubnetId' => 'The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
', 'DescribeNotebookInstanceOutput$SubnetId' => 'The ID of the VPC subnet.
', 'Subnets$member' => NULL, ], ], 'Subnets' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$SubnetIds' => 'The VPC subnets that Studio uses for communication.
', 'DescribeDomainResponse$SubnetIds' => 'The VPC subnets that Studio uses for communication.
', 'VpcConfig$Subnets' => '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.
', ], ], 'SubscribedWorkteam' => [ 'base' => 'Describes a work team of a vendor that does the a labelling job.
', 'refs' => [ 'DescribeSubscribedWorkteamResponse$SubscribedWorkteam' => 'A Workteam instance that contains information about the work team.
An array of Workteam objects, each describing a work team.
Returns true if the work team was successfully deleted; otherwise, returns false.
Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.
', 'refs' => [ 'GetSearchSuggestionsRequest$SuggestionQuery' => 'Limits the property names that are included in the response.
', ], ], 'TableFormat' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreConfig$TableFormat' => 'Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
', ], ], 'TableName' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$TableName' => 'The name of the Glue table.
', ], ], 'TabularJobConfig' => [ 'base' => 'The collection of settings used by an AutoML job V2 for the TABULAR problem type.
Settings used to configure an AutoML job V2 for a tabular problem type (regression, classification).
', ], ], 'TabularResolvedAttributes' => [ 'base' => 'The resolved attributes specific to the TABULAR problem type.
Defines the resolved attributes for the TABULAR problem type.
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.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The tag key. Tag keys must be unique per resource.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'DeleteTagsInput$TagKeys' => 'An array or one or more tag keys to delete.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$Tags' => '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.
', 'AddTagsOutput$Tags' => 'A list of tags associated with the SageMaker resource.
', 'CreateActionRequest$Tags' => 'A list of tags to apply to the action.
', 'CreateAlgorithmInput$Tags' => '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.
', 'CreateAppImageConfigRequest$Tags' => 'A list of tags to apply to the AppImageConfig.
', 'CreateAppRequest$Tags' => 'Each tag consists of a key and an optional value. Tag keys must be unique per resource.
', 'CreateArtifactRequest$Tags' => 'A list of tags to apply to the artifact.
', 'CreateAutoMLJobRequest$Tags' => '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.
', 'CreateAutoMLJobV2Request$Tags' => '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.
', 'CreateCodeRepositoryInput$Tags' => '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.
', 'CreateCompilationJobRequest$Tags' => '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.
', 'CreateContextRequest$Tags' => 'A list of tags to apply to the context.
', 'CreateDataQualityJobDefinitionRequest$Tags' => '(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.
', 'CreateDeviceFleetRequest$Tags' => 'Creates tags for the specified fleet.
', 'CreateDomainRequest$Tags' => '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.
', 'CreateEdgeDeploymentPlanRequest$Tags' => 'List of tags with which to tag the edge deployment plan.
', 'CreateEdgePackagingJobRequest$Tags' => 'Creates tags for the packaging job.
', 'CreateEndpointConfigInput$Tags' => '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.
', 'CreateEndpointInput$Tags' => '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.
', 'CreateExperimentRequest$Tags' => 'A list of tags to associate with the experiment. You can use Search API to search on the tags.
', 'CreateFeatureGroupRequest$Tags' => 'Tags used to identify Features in each FeatureGroup.
An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.
', 'CreateHubRequest$Tags' => 'Any tags to associate with the hub.
', 'CreateHumanTaskUiRequest$Tags' => 'An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.
', 'CreateHyperParameterTuningJobRequest$Tags' => '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.
', 'CreateImageRequest$Tags' => 'A list of tags to apply to the image.
', 'CreateInferenceExperimentRequest$Tags' => '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.
', 'CreateInferenceRecommendationsJobRequest$Tags' => '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.
', 'CreateLabelingJobRequest$Tags' => '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.
', 'CreateModelBiasJobDefinitionRequest$Tags' => '(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.
', 'CreateModelCardRequest$Tags' => 'Key-value pairs used to manage metadata for model cards.
', 'CreateModelExplainabilityJobDefinitionRequest$Tags' => '(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.
', 'CreateModelInput$Tags' => '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.
', 'CreateModelPackageGroupInput$Tags' => '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.
', 'CreateModelPackageInput$Tags' => '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.
', 'CreateModelQualityJobDefinitionRequest$Tags' => '(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.
', 'CreateMonitoringScheduleRequest$Tags' => '(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.
', 'CreateNotebookInstanceInput$Tags' => '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.
', 'CreatePipelineRequest$Tags' => 'A list of tags to apply to the created pipeline.
', 'CreateProcessingJobRequest$Tags' => '(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.
', 'CreateProjectInput$Tags' => '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.
', 'CreateSpaceRequest$Tags' => '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.
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.
', 'CreateTrainingJobRequest$Tags' => '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.
', 'CreateTransformJobRequest$Tags' => '(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.
', 'CreateTrialComponentRequest$Tags' => 'A list of tags to associate with the component. You can use Search API to search on the tags.
', 'CreateTrialRequest$Tags' => 'A list of tags to associate with the trial. You can use Search API to search on the tags.
', 'CreateUserProfileRequest$Tags' => '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.
', 'CreateWorkforceRequest$Tags' => '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.
', 'CreateWorkteamRequest$Tags' => '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.
', 'DescribeLabelingJobResponse$Tags' => '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.
', 'Endpoint$Tags' => '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.
', 'Experiment$Tags' => 'The list of tags that are associated with the experiment. You can use Search API to search on the tags.
', 'FeatureGroup$Tags' => 'Tags used to define a FeatureGroup.
The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
', 'ImportHubContentRequest$Tags' => 'Any tags associated with the hub content.
', 'ListTagsOutput$Tags' => 'An array of Tag objects, each with a tag key and a value.
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.
', 'ModelCard$Tags' => 'Key-value pairs used to manage metadata for the model card.
', 'ModelDashboardModelCard$Tags' => 'The tags associated with a model card.
', 'ModelPackage$Tags' => '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.
', 'ModelPackageGroup$Tags' => '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.
', 'MonitoringSchedule$Tags' => '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.
', 'Pipeline$Tags' => 'A list of tags that apply to the pipeline.
', 'ProcessingJob$Tags' => '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.
', 'Project$Tags' => '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.
', 'RegisterDevicesRequest$Tags' => 'The tags associated with devices.
', 'TrainingJob$Tags' => '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.
', 'TransformJob$Tags' => 'A list of tags associated with the transform job.
', 'Trial$Tags' => 'The list of tags that are associated with the trial. You can use Search API to search on the tags.
', 'TrialComponent$Tags' => 'The list of tags that are associated with the component. You can use Search API to search on the tags.
', 'UpdateProjectInput$Tags' => '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.
', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The tag value.
', ], ], 'TargetAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$TargetAttributeName' => 'The name of the target variable in supervised learning, usually represented by \'y\'.
', 'TabularJobConfig$TargetAttributeName' => 'The name of the target variable in supervised learning, usually represented by \'y\'.
', 'TimeSeriesConfig$TargetAttributeName' => '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.
', ], ], 'TargetDevice' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetDevice' => 'The type of device that the model will run on after the compilation job has completed.
', 'OutputConfig$TargetDevice' => '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.
The name of the column used to provide the class labels. It should not be same as the content column.
', ], ], 'TargetObjectiveMetricValue' => [ 'base' => NULL, 'refs' => [ 'TuningJobCompletionCriteria$TargetObjectiveMetricValue' => 'The value of the objective metric.
', ], ], 'TargetPlatform' => [ 'base' => '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.
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}
The type of accelerator that the model will run on after the compilation job has completed.
', 'TargetPlatform$Accelerator' => '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
The type of architecture that the model will run on after the compilation job has completed.
', 'TargetPlatform$Arch' => '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.
The type of OS that the model will run on after the compilation job has completed.
', 'TargetPlatform$Os' => '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}
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.
A target tracking scaling policy. Includes support for predefined or customized metrics.
', ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskAvailabilityLifetimeInSeconds' => 'The 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.
The variant\'s capacity.
', 'PendingProductionVariantSummary$CurrentInstanceCount' => 'The number of instances associated with the variant.
', 'PendingProductionVariantSummary$DesiredInstanceCount' => '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.
', 'ProductionVariantSummary$CurrentInstanceCount' => 'The number of instances associated with the variant.
', 'ProductionVariantSummary$DesiredInstanceCount' => 'The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
The number of instances of the type specified by InstanceType.
A description of the task for your human workers.
', ], ], 'TaskInput' => [ 'base' => NULL, 'refs' => [ 'RenderableTask$Input' => '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".
Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
', ], ], 'TaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTimeLimitInSeconds' => 'The 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.
A title for the task for your human workers.
', ], ], 'TemplateContent' => [ 'base' => NULL, 'refs' => [ 'UiTemplate$Content' => 'The content of the Liquid template for the worker user interface.
', ], ], 'TemplateContentSha256' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$ContentSha256' => 'The SHA-256 digest of the contents of the template.
', ], ], 'TemplateUrl' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$Url' => 'The URL for the user interface template.
', ], ], 'TensorBoardAppSettings' => [ 'base' => 'The TensorBoard app settings.
', 'refs' => [ 'UserSettings$TensorBoardAppSettings' => 'The TensorBoard app settings.
', ], ], 'TensorBoardOutputConfig' => [ 'base' => 'Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
', 'refs' => [ 'CreateTrainingJobRequest$TensorBoardOutputConfig' => NULL, 'DescribeTrainingJobResponse$TensorBoardOutputConfig' => NULL, 'TrainingJob$TensorBoardOutputConfig' => NULL, ], ], 'TenthFractionsOfACent' => [ 'base' => NULL, 'refs' => [ 'USD$TenthFractionsOfACent' => 'Fractions of a cent, in tenths.
', ], ], 'TerminationWaitInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$TerminationWaitInSeconds' => 'Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.
', ], ], 'TextClassificationJobConfig' => [ 'base' => 'Stores the configuration information for the text classification problem of an AutoML job V2.
', 'refs' => [ 'AutoMLProblemTypeConfig$TextClassificationJobConfig' => 'Settings used to configure an AutoML job V2 for the text classification problem type.
', ], ], 'ThingName' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$IotThingName' => 'The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.
', 'Device$IotThingName' => 'Amazon Web Services Internet of Things (IoT) object name.
', 'DeviceSummary$IotThingName' => 'The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
', ], ], 'TimeSeriesConfig' => [ 'base' => 'The collection of components that defines the time-series.
', 'refs' => [ 'TimeSeriesForecastingJobConfig$TimeSeriesConfig' => 'The collection of components that defines the time-series.
', ], ], 'TimeSeriesForecastingJobConfig' => [ 'base' => 'The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.
The TimeSeriesForecastingJobConfig problem type is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.
Settings used to configure an AutoML job V2 for a time-series forecasting problem type.
The TimeSeriesForecastingJobConfig problem type is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.
Time series forecast settings for the SageMaker Canvas application.
', 'refs' => [ 'CanvasAppSettings$TimeSeriesForecastingSettings' => 'Time series forecast settings for the Canvas application.
', ], ], 'TimeSeriesTransformations' => [ 'base' => '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 transformations modifying specific attributes of the time-series, such as filling strategies for missing values.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$CreationTime' => 'When the action was created.
', 'ActionSummary$LastModifiedTime' => 'When the action was last modified.
', 'AppImageConfigDetails$CreationTime' => 'When the AppImageConfig was created.
', 'AppImageConfigDetails$LastModifiedTime' => 'When the AppImageConfig was last modified.
', 'ArtifactSummary$CreationTime' => 'When the artifact was created.
', 'ArtifactSummary$LastModifiedTime' => 'When the artifact was last modified.
', 'AssociationSummary$CreationTime' => 'When the association was created.
', 'AutoMLCandidate$CreationTime' => 'The creation time.
', 'AutoMLCandidate$EndTime' => 'The end time.
', 'AutoMLCandidate$LastModifiedTime' => 'The last modified time.
', 'AutoMLJobSummary$CreationTime' => 'When the AutoML job was created.
', 'AutoMLJobSummary$EndTime' => 'The end time of an AutoML job.
', 'AutoMLJobSummary$LastModifiedTime' => 'When the AutoML job was last modified.
', 'CompilationJobSummary$CompilationStartTime' => 'The time when the model compilation job started.
', 'CompilationJobSummary$CompilationEndTime' => 'The time when the model compilation job completed.
', 'ContextSummary$CreationTime' => 'When the context was created.
', 'ContextSummary$LastModifiedTime' => 'When the context was last modified.
', 'CreateTrialComponentRequest$StartTime' => 'When the component started.
', 'CreateTrialComponentRequest$EndTime' => 'When the component ended.
', 'DebugRuleEvaluationStatus$LastModifiedTime' => 'Timestamp when the rule evaluation status was last modified.
', 'DeployedImage$ResolutionTime' => 'The date and time when the image path for the model resolved to the ResolvedImage
When the action was created.
', 'DescribeActionResponse$LastModifiedTime' => 'When the action was last modified.
', 'DescribeAppImageConfigResponse$CreationTime' => 'When the AppImageConfig was created.
', 'DescribeAppImageConfigResponse$LastModifiedTime' => 'When the AppImageConfig was last modified.
', 'DescribeAppResponse$LastHealthCheckTimestamp' => 'The timestamp of the last health check.
', 'DescribeAppResponse$LastUserActivityTimestamp' => 'The timestamp of the last user\'s activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.
When the artifact was created.
', 'DescribeArtifactResponse$LastModifiedTime' => 'When the artifact was last modified.
', 'DescribeAutoMLJobResponse$CreationTime' => 'Returns the creation time of the AutoML job.
', 'DescribeAutoMLJobResponse$EndTime' => 'Returns the end time of the AutoML job.
', 'DescribeAutoMLJobResponse$LastModifiedTime' => 'Returns the job\'s last modified time.
', 'DescribeAutoMLJobV2Response$CreationTime' => 'Returns the creation time of the AutoML job V2.
', 'DescribeAutoMLJobV2Response$EndTime' => 'Returns the end time of the AutoML job V2.
', 'DescribeAutoMLJobV2Response$LastModifiedTime' => 'Returns the job\'s last modified time.
', 'DescribeCompilationJobResponse$CompilationStartTime' => '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 successful or stopped job, this is when the job\'s model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
', 'DescribeContextResponse$CreationTime' => 'When the context was created.
', 'DescribeContextResponse$LastModifiedTime' => 'When the context was last modified.
', 'DescribeDataQualityJobDefinitionResponse$CreationTime' => 'The time that the data quality monitoring job definition was created.
', 'DescribeDeviceFleetResponse$CreationTime' => 'Timestamp of when the device fleet was created.
', 'DescribeDeviceFleetResponse$LastModifiedTime' => 'Timestamp of when the device fleet was last updated.
', 'DescribeDeviceResponse$RegistrationTime' => 'The timestamp of the last registration or de-reregistration.
', 'DescribeDeviceResponse$LatestHeartbeat' => 'The last heartbeat received from the device.
', 'DescribeEdgeDeploymentPlanResponse$CreationTime' => 'The time when the edge deployment plan was created.
', 'DescribeEdgeDeploymentPlanResponse$LastModifiedTime' => 'The time when the edge deployment plan was last updated.
', 'DescribeEdgePackagingJobResponse$CreationTime' => 'The timestamp of when the packaging job was created.
', 'DescribeEdgePackagingJobResponse$LastModifiedTime' => 'The timestamp of when the job was last updated.
', 'DescribeEndpointConfigOutput$CreationTime' => 'A timestamp that shows when the endpoint configuration was created.
', 'DescribeEndpointOutput$CreationTime' => 'A timestamp that shows when the endpoint was created.
', 'DescribeEndpointOutput$LastModifiedTime' => 'A timestamp that shows when the endpoint was last modified.
', 'DescribeExperimentResponse$CreationTime' => 'When the experiment was created.
', 'DescribeExperimentResponse$LastModifiedTime' => 'When the experiment was last modified.
', 'DescribeFlowDefinitionResponse$CreationTime' => 'The timestamp when the flow definition was created.
', 'DescribeHubContentResponse$CreationTime' => 'The date and time that hub content was created.
', 'DescribeHubResponse$CreationTime' => 'The date and time that the hub was created.
', 'DescribeHubResponse$LastModifiedTime' => 'The date and time that the hub was last modified.
', 'DescribeHumanTaskUiResponse$CreationTime' => 'The timestamp when the human task user interface was created.
', 'DescribeHyperParameterTuningJobResponse$CreationTime' => 'The date and time that the tuning job started.
', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningEndTime' => 'The date and time that the tuning job ended.
', 'DescribeHyperParameterTuningJobResponse$LastModifiedTime' => 'The date and time that the status of the tuning job was modified.
', 'DescribeImageResponse$CreationTime' => 'When the image was created.
', 'DescribeImageResponse$LastModifiedTime' => 'When the image was last modified.
', 'DescribeImageVersionResponse$CreationTime' => 'When the version was created.
', 'DescribeImageVersionResponse$LastModifiedTime' => 'When the version was last modified.
', 'DescribeInferenceExperimentResponse$CreationTime' => 'The timestamp at which you created the inference experiment.
', 'DescribeInferenceExperimentResponse$CompletionTime' => 'The timestamp at which the inference experiment was completed.
', 'DescribeInferenceExperimentResponse$LastModifiedTime' => 'The timestamp at which you last modified the inference experiment.
', 'DescribeInferenceRecommendationsJobResponse$CompletionTime' => 'A timestamp that shows when the job completed.
', 'DescribeLabelingJobResponse$CreationTime' => 'The date and time that the labeling job was created.
', 'DescribeLabelingJobResponse$LastModifiedTime' => 'The date and time that the labeling job was last updated.
', 'DescribeLineageGroupResponse$CreationTime' => 'The creation time of lineage group.
', 'DescribeLineageGroupResponse$LastModifiedTime' => 'The last modified time of the lineage group.
', 'DescribeModelBiasJobDefinitionResponse$CreationTime' => 'The time at which the model bias job was created.
', 'DescribeModelCardExportJobResponse$CreatedAt' => 'The date and time that the model export job was created.
', 'DescribeModelCardExportJobResponse$LastModifiedAt' => 'The date and time that the model export job was last modified.
', 'DescribeModelCardResponse$CreationTime' => 'The date and time the model card was created.
', 'DescribeModelCardResponse$LastModifiedTime' => 'The date and time the model card was last modified.
', 'DescribeModelExplainabilityJobDefinitionResponse$CreationTime' => 'The time at which the model explainability job was created.
', 'DescribeModelOutput$CreationTime' => 'A timestamp that shows when the model was created.
', 'DescribeModelPackageOutput$LastModifiedTime' => 'The last time that the model package was modified.
', 'DescribeModelQualityJobDefinitionResponse$CreationTime' => 'The time at which the model quality job was created.
', 'DescribeMonitoringScheduleResponse$CreationTime' => 'The time at which the monitoring job was created.
', 'DescribeMonitoringScheduleResponse$LastModifiedTime' => 'The time at which the monitoring job was last modified.
', 'DescribePipelineDefinitionForExecutionResponse$CreationTime' => 'The time when the pipeline was created.
', 'DescribePipelineExecutionResponse$CreationTime' => 'The time when the pipeline execution was created.
', 'DescribePipelineExecutionResponse$LastModifiedTime' => 'The time when the pipeline execution was modified last.
', 'DescribePipelineResponse$CreationTime' => 'The time when the pipeline was created.
', 'DescribePipelineResponse$LastModifiedTime' => 'The time when the pipeline was last modified.
', 'DescribePipelineResponse$LastRunTime' => 'The time when the pipeline was last run.
', 'DescribeProcessingJobResponse$ProcessingEndTime' => 'The time at which the processing job completed.
', 'DescribeProcessingJobResponse$ProcessingStartTime' => 'The time at which the processing job started.
', 'DescribeProcessingJobResponse$LastModifiedTime' => 'The time at which the processing job was last modified.
', 'DescribeProcessingJobResponse$CreationTime' => 'The time at which the processing job was created.
', 'DescribeProjectOutput$CreationTime' => 'The time when the project was created.
', 'DescribeProjectOutput$LastModifiedTime' => 'The timestamp when project was last modified.
', 'DescribeStudioLifecycleConfigResponse$CreationTime' => 'The creation time of the Studio Lifecycle Configuration.
', 'DescribeStudioLifecycleConfigResponse$LastModifiedTime' => 'This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.
', 'DescribeTrainingJobResponse$CreationTime' => 'A timestamp that indicates when the training job was created.
', 'DescribeTrainingJobResponse$TrainingStartTime' => '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 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 modified.
', 'DescribeTransformJobResponse$CreationTime' => 'A timestamp that shows when the transform Job was created.
', 'DescribeTransformJobResponse$TransformStartTime' => '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 billed for the time interval between this time and the value of TransformStartTime.
When the component started.
', 'DescribeTrialComponentResponse$EndTime' => 'When the component ended.
', 'DescribeTrialComponentResponse$CreationTime' => 'When the component was created.
', 'DescribeTrialComponentResponse$LastModifiedTime' => 'When the component was last modified.
', 'DescribeTrialResponse$CreationTime' => 'When the trial was created.
', 'DescribeTrialResponse$LastModifiedTime' => 'When the trial was last modified.
', 'DeviceDeploymentSummary$DeploymentStartTime' => 'The time when the deployment on the device started.
', 'DeviceFleetSummary$CreationTime' => 'Timestamp of when the device fleet was created.
', 'DeviceFleetSummary$LastModifiedTime' => 'Timestamp of when the device fleet was last updated.
', 'DeviceSummary$RegistrationTime' => 'The timestamp of the last registration or de-reregistration.
', 'DeviceSummary$LatestHeartbeat' => 'The last heartbeat received from the device.
', 'EdgeDeploymentPlanSummary$CreationTime' => 'The time when the edge deployment plan was created.
', 'EdgeDeploymentPlanSummary$LastModifiedTime' => 'The time when the edge deployment plan was last updated.
', 'EdgeDeploymentStatus$EdgeDeploymentStageStartTime' => 'The time when the deployment API started.
', 'EdgeModel$LatestSampleTime' => 'The timestamp of the last data sample taken.
', 'EdgeModel$LatestInference' => 'The timestamp of the last inference that was made.
', 'EdgePackagingJobSummary$CreationTime' => 'The timestamp of when the job was created.
', 'EdgePackagingJobSummary$LastModifiedTime' => 'The timestamp of when the edge packaging job was last updated.
', 'Endpoint$CreationTime' => 'The time that the endpoint was created.
', 'Endpoint$LastModifiedTime' => 'The last time the endpoint was modified.
', 'EndpointConfigSummary$CreationTime' => 'A timestamp that shows when the endpoint configuration was created.
', 'EndpointSummary$CreationTime' => 'A timestamp that shows when the endpoint was created.
', 'EndpointSummary$LastModifiedTime' => 'A timestamp that shows when the endpoint was last modified.
', 'Experiment$CreationTime' => 'When the experiment was created.
', 'Experiment$LastModifiedTime' => 'When the experiment was last modified.
', 'ExperimentSummary$CreationTime' => 'When the experiment was created.
', 'ExperimentSummary$LastModifiedTime' => 'When the experiment was last modified.
', 'FeatureGroupSummary$CreationTime' => 'A timestamp indicating the time of creation time of the FeatureGroup.
The timestamp when SageMaker created the flow definition.
', 'GetDeviceFleetReportResponse$ReportGenerated' => 'Timestamp of when the report was generated.
', 'HubContentInfo$CreationTime' => 'The date and time that the hub content was created.
', 'HubInfo$CreationTime' => 'The date and time that the hub was created.
', 'HubInfo$LastModifiedTime' => 'The date and time that the hub was last modified.
', 'HumanTaskUiSummary$CreationTime' => 'A timestamp when SageMaker created the human task user interface.
', 'HyperParameterTrainingJobSummary$CreationTime' => 'The date and time that the training job was created.
', 'HyperParameterTrainingJobSummary$TrainingStartTime' => 'The date and time that the training job started.
', 'HyperParameterTrainingJobSummary$TrainingEndTime' => '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 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.
', 'HyperParameterTuningJobSearchEntity$CreationTime' => 'The time that a hyperparameter tuning job was created.
', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningEndTime' => 'The time that a hyperparameter tuning job ended.
', 'HyperParameterTuningJobSearchEntity$LastModifiedTime' => 'The time that a hyperparameter tuning job was last modified.
', 'HyperParameterTuningJobSummary$CreationTime' => 'The date and time that the tuning job was created.
', 'HyperParameterTuningJobSummary$HyperParameterTuningEndTime' => 'The date and time that the tuning job ended.
', 'HyperParameterTuningJobSummary$LastModifiedTime' => 'The date and time that the tuning job was modified.
', 'Image$CreationTime' => 'When the image was created.
', 'Image$LastModifiedTime' => 'When the image was last modified.
', 'ImageVersion$CreationTime' => 'When the version was created.
', 'ImageVersion$LastModifiedTime' => 'When the version was last modified.
', 'InferenceExperimentSchedule$StartTime' => 'The timestamp at which the inference experiment started or will start.
', 'InferenceExperimentSchedule$EndTime' => 'The timestamp at which the inference experiment ended or will end.
', 'InferenceExperimentSummary$CreationTime' => 'The timestamp at which the inference experiment was created.
', 'InferenceExperimentSummary$CompletionTime' => 'The timestamp at which the inference experiment was completed.
', 'InferenceExperimentSummary$LastModifiedTime' => 'The timestamp when you last modified the inference experiment.
', 'InferenceRecommendationsJob$CompletionTime' => 'A timestamp that shows when the job completed.
', 'LabelingJobForWorkteamSummary$CreationTime' => 'The date and time that the labeling job was created.
', 'LabelingJobSummary$CreationTime' => 'The date and time that the job was created (timestamp).
', 'LabelingJobSummary$LastModifiedTime' => 'The date and time that the job was last modified (timestamp).
', 'LineageGroupSummary$CreationTime' => 'The creation time of the lineage group summary.
', 'LineageGroupSummary$LastModifiedTime' => 'The last modified time of the lineage group summary.
', 'ListActionsRequest$CreatedAfter' => 'A filter that returns only actions created on or after the specified time.
', 'ListActionsRequest$CreatedBefore' => 'A filter that returns only actions created on or before the specified time.
', 'ListAppImageConfigsRequest$CreationTimeBefore' => 'A filter that returns only AppImageConfigs created on or before the specified time.
', 'ListAppImageConfigsRequest$CreationTimeAfter' => 'A filter that returns only AppImageConfigs created on or after the specified time.
', 'ListAppImageConfigsRequest$ModifiedTimeBefore' => 'A filter that returns only AppImageConfigs modified on or before the specified time.
', 'ListAppImageConfigsRequest$ModifiedTimeAfter' => 'A filter that returns only AppImageConfigs modified on or after the specified time.
', 'ListArtifactsRequest$CreatedAfter' => 'A filter that returns only artifacts created on or after the specified time.
', 'ListArtifactsRequest$CreatedBefore' => 'A filter that returns only artifacts created on or before the specified time.
', 'ListAssociationsRequest$CreatedAfter' => 'A filter that returns only associations created on or after the specified time.
', 'ListAssociationsRequest$CreatedBefore' => 'A filter that returns only associations created on or before the specified time.
', 'ListAutoMLJobsRequest$CreationTimeAfter' => 'Request a list of jobs, using a filter for time.
', 'ListAutoMLJobsRequest$CreationTimeBefore' => 'Request a list of jobs, using a filter for time.
', 'ListAutoMLJobsRequest$LastModifiedTimeAfter' => 'Request a list of jobs, using a filter for time.
', 'ListAutoMLJobsRequest$LastModifiedTimeBefore' => 'Request a list of jobs, using a filter for time.
', 'ListCodeRepositoriesInput$LastModifiedTimeAfter' => 'A filter that returns only Git repositories that were last modified after the specified time.
', 'ListCodeRepositoriesInput$LastModifiedTimeBefore' => 'A filter that returns only Git repositories that were last modified before the specified time.
', 'ListContextsRequest$CreatedAfter' => 'A filter that returns only contexts created on or after the specified time.
', 'ListContextsRequest$CreatedBefore' => 'A filter that returns only contexts created on or before the specified time.
', 'ListDataQualityJobDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only data quality monitoring job definitions created before the specified time.
', 'ListDataQualityJobDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only data quality monitoring job definitions created after the specified time.
', 'ListDeviceFleetsRequest$CreationTimeAfter' => 'Filter fleets where packaging job was created after specified time.
', 'ListDeviceFleetsRequest$CreationTimeBefore' => 'Filter fleets where the edge packaging job was created before specified time.
', 'ListDeviceFleetsRequest$LastModifiedTimeAfter' => 'Select fleets where the job was updated after X
', 'ListDeviceFleetsRequest$LastModifiedTimeBefore' => 'Select fleets where the job was updated before X
', 'ListDevicesRequest$LatestHeartbeatAfter' => 'Select fleets where the job was updated after X
', 'ListEdgeDeploymentPlansRequest$CreationTimeAfter' => 'Selects edge deployment plans created after this time.
', 'ListEdgeDeploymentPlansRequest$CreationTimeBefore' => 'Selects edge deployment plans created before this time.
', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeAfter' => 'Selects edge deployment plans that were last updated after this time.
', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeBefore' => 'Selects edge deployment plans that were last updated before this time.
', 'ListEdgePackagingJobsRequest$CreationTimeAfter' => 'Select jobs where the job was created after specified time.
', 'ListEdgePackagingJobsRequest$CreationTimeBefore' => 'Select jobs where the job was created before specified time.
', 'ListEdgePackagingJobsRequest$LastModifiedTimeAfter' => 'Select jobs where the job was updated after specified time.
', 'ListEdgePackagingJobsRequest$LastModifiedTimeBefore' => 'Select jobs where the job was updated before specified time.
', 'ListEndpointConfigsInput$CreationTimeBefore' => 'A filter that returns only endpoint configurations created before the specified time (timestamp).
', 'ListEndpointConfigsInput$CreationTimeAfter' => 'A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).
', 'ListEndpointsInput$CreationTimeBefore' => 'A filter that returns only endpoints that were created before the specified time (timestamp).
', 'ListEndpointsInput$CreationTimeAfter' => 'A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
', 'ListEndpointsInput$LastModifiedTimeBefore' => 'A filter that returns only endpoints that were modified before the specified timestamp.
', 'ListEndpointsInput$LastModifiedTimeAfter' => 'A filter that returns only endpoints that were modified after the specified timestamp.
', 'ListExperimentsRequest$CreatedAfter' => 'A filter that returns only experiments created after the specified time.
', 'ListExperimentsRequest$CreatedBefore' => 'A filter that returns only experiments created before the specified time.
', 'ListFlowDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
', 'ListFlowDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only flow definitions that were created before the specified timestamp.
', 'ListHubContentVersionsRequest$CreationTimeBefore' => 'Only list hub content versions that were created before the time specified.
', 'ListHubContentVersionsRequest$CreationTimeAfter' => 'Only list hub content versions that were created after the time specified.
', 'ListHubContentsRequest$CreationTimeBefore' => 'Only list hub content that was created before the time specified.
', 'ListHubContentsRequest$CreationTimeAfter' => 'Only list hub content that was created after the time specified.
', 'ListHubsRequest$CreationTimeBefore' => 'Only list hubs that were created before the time specified.
', 'ListHubsRequest$CreationTimeAfter' => 'Only list hubs that were created after the time specified.
', 'ListHubsRequest$LastModifiedTimeBefore' => 'Only list hubs that were last modified before the time specified.
', 'ListHubsRequest$LastModifiedTimeAfter' => 'Only list hubs that were last modified after the time specified.
', 'ListHumanTaskUisRequest$CreationTimeAfter' => 'A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
', 'ListHumanTaskUisRequest$CreationTimeBefore' => 'A filter that returns only human task user interfaces that were created before the specified timestamp.
', 'ListHyperParameterTuningJobsRequest$CreationTimeAfter' => 'A filter that returns only tuning jobs that were created after the specified time.
', 'ListHyperParameterTuningJobsRequest$CreationTimeBefore' => 'A filter that returns only tuning jobs that were created before the specified time.
', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only tuning jobs that were modified after the specified time.
', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only tuning jobs that were modified before the specified time.
', 'ListImageVersionsRequest$CreationTimeAfter' => 'A filter that returns only versions created on or after the specified time.
', 'ListImageVersionsRequest$CreationTimeBefore' => 'A filter that returns only versions created on or before the specified time.
', 'ListImageVersionsRequest$LastModifiedTimeAfter' => 'A filter that returns only versions modified on or after the specified time.
', 'ListImageVersionsRequest$LastModifiedTimeBefore' => 'A filter that returns only versions modified on or before the specified time.
', 'ListImagesRequest$CreationTimeAfter' => 'A filter that returns only images created on or after the specified time.
', 'ListImagesRequest$CreationTimeBefore' => 'A filter that returns only images created on or before the specified time.
', 'ListImagesRequest$LastModifiedTimeAfter' => 'A filter that returns only images modified on or after the specified time.
', 'ListImagesRequest$LastModifiedTimeBefore' => 'A filter that returns only images modified on or before the specified time.
', 'ListInferenceExperimentsRequest$CreationTimeAfter' => 'Selects inference experiments which were created after this timestamp.
', 'ListInferenceExperimentsRequest$CreationTimeBefore' => 'Selects inference experiments which were created before this timestamp.
', 'ListInferenceExperimentsRequest$LastModifiedTimeAfter' => 'Selects inference experiments which were last modified after this timestamp.
', 'ListInferenceExperimentsRequest$LastModifiedTimeBefore' => 'Selects inference experiments which were last modified before this timestamp.
', 'ListLabelingJobsForWorkteamRequest$CreationTimeAfter' => 'A filter that returns only labeling jobs created after the specified time (timestamp).
', 'ListLabelingJobsForWorkteamRequest$CreationTimeBefore' => 'A filter that returns only labeling jobs created before the specified time (timestamp).
', 'ListLabelingJobsRequest$CreationTimeAfter' => 'A filter that returns only labeling jobs created after the specified time (timestamp).
', 'ListLabelingJobsRequest$CreationTimeBefore' => 'A filter that returns only labeling jobs created before the specified time (timestamp).
', 'ListLabelingJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only labeling jobs modified after the specified time (timestamp).
', 'ListLabelingJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only labeling jobs modified before the specified time (timestamp).
', 'ListLineageGroupsRequest$CreatedAfter' => 'A timestamp to filter against lineage groups created after a certain point in time.
', 'ListLineageGroupsRequest$CreatedBefore' => 'A timestamp to filter against lineage groups created before a certain point in time.
', 'ListModelBiasJobDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only model bias jobs created before a specified time.
', 'ListModelBiasJobDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only model bias jobs created after a specified time.
', 'ListModelCardExportJobsRequest$CreationTimeAfter' => 'Only list model card export jobs that were created after the time specified.
', 'ListModelCardExportJobsRequest$CreationTimeBefore' => 'Only list model card export jobs that were created before the time specified.
', 'ListModelCardVersionsRequest$CreationTimeAfter' => 'Only list model card versions that were created after the time specified.
', 'ListModelCardVersionsRequest$CreationTimeBefore' => 'Only list model card versions that were created before the time specified.
', 'ListModelCardsRequest$CreationTimeAfter' => 'Only list model cards that were created after the time specified.
', 'ListModelCardsRequest$CreationTimeBefore' => 'Only list model cards that were created before the time specified.
', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only model explainability jobs created before a specified time.
', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only model explainability jobs created after a specified time.
', 'ListModelQualityJobDefinitionsRequest$CreationTimeBefore' => 'A filter that returns only model quality monitoring job definitions created before the specified time.
', 'ListModelQualityJobDefinitionsRequest$CreationTimeAfter' => 'A filter that returns only model quality monitoring job definitions created after the specified time.
', 'ListModelsInput$CreationTimeBefore' => 'A filter that returns only models created before the specified time (timestamp).
', 'ListModelsInput$CreationTimeAfter' => 'A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
', 'ListMonitoringAlertHistoryRequest$CreationTimeBefore' => 'A filter that returns only alerts created on or before the specified time.
', 'ListMonitoringAlertHistoryRequest$CreationTimeAfter' => 'A filter that returns only alerts created on or after the specified time.
', 'ListMonitoringExecutionsRequest$ScheduledTimeBefore' => 'Filter for jobs scheduled before a specified time.
', 'ListMonitoringExecutionsRequest$ScheduledTimeAfter' => 'Filter for jobs scheduled after a specified time.
', 'ListMonitoringExecutionsRequest$CreationTimeBefore' => 'A filter that returns only jobs created before a specified time.
', 'ListMonitoringExecutionsRequest$CreationTimeAfter' => 'A filter that returns only jobs created after a specified time.
', 'ListMonitoringExecutionsRequest$LastModifiedTimeBefore' => 'A filter that returns only jobs modified after a specified time.
', 'ListMonitoringExecutionsRequest$LastModifiedTimeAfter' => 'A filter that returns only jobs modified before a specified time.
', 'ListMonitoringSchedulesRequest$CreationTimeBefore' => 'A filter that returns only monitoring schedules created before a specified time.
', 'ListMonitoringSchedulesRequest$CreationTimeAfter' => 'A filter that returns only monitoring schedules created after a specified time.
', 'ListMonitoringSchedulesRequest$LastModifiedTimeBefore' => 'A filter that returns only monitoring schedules modified before a specified time.
', 'ListMonitoringSchedulesRequest$LastModifiedTimeAfter' => 'A filter that returns only monitoring schedules modified after a specified time.
', 'ListPipelineExecutionsRequest$CreatedAfter' => 'A filter that returns the pipeline executions that were created after a specified time.
', 'ListPipelineExecutionsRequest$CreatedBefore' => 'A filter that returns the pipeline executions that were created before a specified time.
', 'ListPipelinesRequest$CreatedAfter' => 'A filter that returns the pipelines that were created after a specified time.
', 'ListPipelinesRequest$CreatedBefore' => 'A filter that returns the pipelines that were created before a specified time.
', 'ListProcessingJobsRequest$CreationTimeAfter' => 'A filter that returns only processing jobs created after the specified time.
', 'ListProcessingJobsRequest$CreationTimeBefore' => 'A filter that returns only processing jobs created after the specified time.
', 'ListProcessingJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only processing jobs modified after the specified time.
', 'ListProcessingJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only processing jobs modified before the specified time.
', 'ListProjectsInput$CreationTimeAfter' => 'A filter that returns the projects that were created after a specified time.
', 'ListProjectsInput$CreationTimeBefore' => 'A filter that returns the projects that were created before a specified time.
', 'ListResourceCatalogsRequest$CreationTimeAfter' => ' Use this parameter to search for ResourceCatalogs created after a specific date and time.
Use this parameter to search for ResourceCatalogs created before a specific date and time.
A filter that returns only Lifecycle Configurations created on or before the specified time.
', 'ListStudioLifecycleConfigsRequest$CreationTimeAfter' => 'A filter that returns only Lifecycle Configurations created on or after the specified time.
', 'ListStudioLifecycleConfigsRequest$ModifiedTimeBefore' => 'A filter that returns only Lifecycle Configurations modified before the specified time.
', 'ListStudioLifecycleConfigsRequest$ModifiedTimeAfter' => 'A filter that returns only Lifecycle Configurations modified after the specified time.
', 'ListTrainingJobsRequest$CreationTimeAfter' => 'A filter that returns only training jobs created after the specified time (timestamp).
', 'ListTrainingJobsRequest$CreationTimeBefore' => 'A filter that returns only training jobs created before the specified time (timestamp).
', 'ListTrainingJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only training jobs modified after the specified time (timestamp).
', 'ListTrainingJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only training jobs modified before the specified time (timestamp).
', 'ListTransformJobsRequest$CreationTimeAfter' => 'A filter that returns only transform jobs created after the specified time.
', 'ListTransformJobsRequest$CreationTimeBefore' => 'A filter that returns only transform jobs created before the specified time.
', 'ListTransformJobsRequest$LastModifiedTimeAfter' => 'A filter that returns only transform jobs modified after the specified time.
', 'ListTransformJobsRequest$LastModifiedTimeBefore' => 'A filter that returns only transform jobs modified before the specified time.
', 'ListTrialComponentsRequest$CreatedAfter' => 'A filter that returns only components created after the specified time.
', 'ListTrialComponentsRequest$CreatedBefore' => 'A filter that returns only components created before the specified time.
', 'ListTrialsRequest$CreatedAfter' => 'A filter that returns only trials created after the specified time.
', 'ListTrialsRequest$CreatedBefore' => 'A filter that returns only trials created before the specified time.
', 'MetricData$Timestamp' => 'The date and time that the algorithm emitted the metric.
', 'Model$CreationTime' => 'A timestamp that indicates when the model was created.
', 'ModelCard$CreationTime' => 'The date and time that the model card was created.
', 'ModelCard$LastModifiedTime' => 'The date and time that the model card was last modified.
', 'ModelCardExportJobSummary$CreatedAt' => 'The date and time that the model card export job was created.
', 'ModelCardExportJobSummary$LastModifiedAt' => 'The date and time that the model card export job was last modified..
', 'ModelCardSummary$CreationTime' => 'The date and time that the model card was created.
', 'ModelCardSummary$LastModifiedTime' => 'The date and time that the model card was last modified.
', 'ModelCardVersionSummary$CreationTime' => 'The date and time that the model card version was created.
', 'ModelCardVersionSummary$LastModifiedTime' => 'The time date and time that the model card version was last modified.
', 'ModelDashboardEndpoint$CreationTime' => 'A timestamp that indicates when the endpoint was created.
', 'ModelDashboardEndpoint$LastModifiedTime' => 'The last time the endpoint was modified.
', 'ModelDashboardModelCard$CreationTime' => 'A timestamp that indicates when the model card was created.
', 'ModelDashboardModelCard$LastModifiedTime' => 'A timestamp that indicates when the model card was last updated.
', 'ModelDashboardMonitoringSchedule$CreationTime' => 'A timestamp that indicates when the monitoring schedule was created.
', 'ModelDashboardMonitoringSchedule$LastModifiedTime' => 'A timestamp that indicates when the monitoring schedule was last updated.
', 'ModelPackage$LastModifiedTime' => 'The last time the model package was modified.
', 'ModelSummary$CreationTime' => 'A timestamp that indicates when the model was created.
', 'MonitoringAlertHistorySummary$CreationTime' => '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.
A timestamp that indicates when a monitor alert was created.
', 'MonitoringAlertSummary$LastModifiedTime' => 'A timestamp that indicates when a monitor alert was last updated.
', 'MonitoringExecutionSummary$ScheduledTime' => 'The time the monitoring job was scheduled.
', 'MonitoringExecutionSummary$CreationTime' => 'The time at which the monitoring job was created.
', 'MonitoringExecutionSummary$LastModifiedTime' => 'A timestamp that indicates the last time the monitoring job was modified.
', 'MonitoringJobDefinitionSummary$CreationTime' => 'The time that the monitoring job was created.
', 'MonitoringSchedule$CreationTime' => 'The time that the monitoring schedule was created.
', 'MonitoringSchedule$LastModifiedTime' => 'The last time the monitoring schedule was changed.
', 'MonitoringScheduleSummary$CreationTime' => 'The creation time of the monitoring schedule.
', 'MonitoringScheduleSummary$LastModifiedTime' => 'The last time the monitoring schedule was modified.
', 'PendingDeploymentSummary$StartTime' => 'The start time of the deployment.
', 'Pipeline$CreationTime' => 'The creation time of the pipeline.
', 'Pipeline$LastModifiedTime' => 'The time that the pipeline was last modified.
', 'Pipeline$LastRunTime' => 'The time when the pipeline was last run.
', 'PipelineExecution$CreationTime' => 'The creation time of the pipeline execution.
', 'PipelineExecution$LastModifiedTime' => 'The time that the pipeline execution was last modified.
', 'PipelineExecutionStep$StartTime' => 'The time that the step started executing.
', 'PipelineExecutionStep$EndTime' => 'The time that the step stopped executing.
', 'PipelineExecutionSummary$StartTime' => 'The start time of the pipeline execution.
', 'PipelineSummary$CreationTime' => 'The creation time of the pipeline.
', 'PipelineSummary$LastModifiedTime' => 'The time that the pipeline was last modified.
', 'PipelineSummary$LastExecutionTime' => 'The last time that a pipeline execution began.
', 'ProcessingJob$ProcessingEndTime' => 'The time that the processing job ended.
', 'ProcessingJob$ProcessingStartTime' => 'The time that the processing job started.
', 'ProcessingJob$LastModifiedTime' => 'The time the processing job was last modified.
', 'ProcessingJob$CreationTime' => 'The time the processing job was created.
', 'ProcessingJobSummary$CreationTime' => 'The time at which the processing job was created.
', 'ProcessingJobSummary$ProcessingEndTime' => 'The time at which the processing job completed.
', 'ProcessingJobSummary$LastModifiedTime' => 'A timestamp that indicates the last time the processing job was modified.
', 'ProductionVariantStatus$StartTime' => 'The start time of the current status change.
', 'ProfilerRuleEvaluationStatus$LastModifiedTime' => 'Timestamp when the rule evaluation status was last modified.
', 'Project$CreationTime' => 'A timestamp specifying when the project was created.
', 'Project$LastModifiedTime' => 'A timestamp container for when the project was last modified.
', 'ProjectSummary$CreationTime' => 'The time that the project was created.
', 'QueryFilters$CreatedBefore' => 'Filter the lineage entities connected to the StartArn(s) by created date.
Filter the lineage entities connected to the StartArn(s) after the create date.
Filter the lineage entities connected to the StartArn(s) before the last modified date.
Filter the lineage entities connected to the StartArn(s) after the last modified date.
The time the ResourceCatalog was created.
A timestamp that shows when the training job transitioned to the current secondary status state.
', 'SecondaryStatusTransition$EndTime' => '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.
', 'StudioLifecycleConfigDetails$CreationTime' => 'The creation time of the Studio Lifecycle Configuration.
', 'StudioLifecycleConfigDetails$LastModifiedTime' => 'This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.
', 'TrainingJob$CreationTime' => 'A timestamp that indicates when the training job was created.
', 'TrainingJob$TrainingStartTime' => '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 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 modified.
', 'TrainingJobSummary$CreationTime' => 'A timestamp that shows when the training job was created.
', 'TrainingJobSummary$TrainingEndTime' => '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).
Timestamp when the training job was last modified.
', 'TransformJob$CreationTime' => 'A timestamp that shows when the transform Job was created.
', 'TransformJob$TransformStartTime' => '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 billed for the time interval between this time and the value of TransformStartTime.
A timestamp that shows when the transform Job was created.
', 'TransformJobSummary$TransformEndTime' => '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.
', 'TransformJobSummary$LastModifiedTime' => 'Indicates when the transform job was last modified.
', 'Trial$CreationTime' => 'When the trial was created.
', 'Trial$LastModifiedTime' => 'Who last modified the trial.
', 'TrialComponent$StartTime' => 'When the component started.
', 'TrialComponent$EndTime' => 'When the component ended.
', 'TrialComponent$CreationTime' => 'When the component was created.
', 'TrialComponent$LastModifiedTime' => 'When the component was last modified.
', 'TrialComponentMetricSummary$TimeStamp' => 'When the metric was last updated.
', 'TrialComponentSimpleSummary$CreationTime' => 'When the component was created.
', 'TrialComponentSummary$StartTime' => 'When the component started.
', 'TrialComponentSummary$EndTime' => 'When the component ended.
', 'TrialComponentSummary$CreationTime' => 'When the component was created.
', 'TrialComponentSummary$LastModifiedTime' => 'When the component was last modified.
', 'TrialSummary$CreationTime' => 'When the trial was created.
', 'TrialSummary$LastModifiedTime' => 'When the trial was last modified.
', 'UpdateTrialComponentRequest$StartTime' => 'When the component started.
', 'UpdateTrialComponentRequest$EndTime' => 'When the component ended.
', 'Workforce$LastUpdatedDate' => '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.
', 'Workforce$CreateDate' => 'The date that the workforce is created.
', 'Workteam$CreateDate' => 'The date and time that the work team was created (timestamp).
', 'Workteam$LastUpdatedDate' => 'The date and time that the work team was last updated (timestamp).
', ], ], 'TimestampAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$TimestampAttributeName' => 'The name of the column indicating a point in time at which the target value of a given item is recorded.
', ], ], 'TrafficDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Phase$DurationInSeconds' => '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.
Defines how long each traffic step should be.
', ], ], 'TrafficPattern' => [ 'base' => 'Defines the traffic pattern of the load test.
', 'refs' => [ 'RecommendationJobInputConfig$TrafficPattern' => 'Specifies the traffic pattern of the job.
', ], ], 'TrafficRoutingConfig' => [ 'base' => 'Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.
', 'refs' => [ 'BlueGreenUpdatePolicy$TrafficRoutingConfiguration' => 'Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.
', ], ], 'TrafficRoutingConfigType' => [ 'base' => NULL, 'refs' => [ 'TrafficRoutingConfig$Type' => '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.
Defines the traffic patterns. Choose either PHASES or STAIRS.
The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.
', ], ], 'TrainingContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerEntrypoint' => '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.
', ], ], 'TrainingContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerEntrypoint$member' => NULL, ], ], 'TrainingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$key' => NULL, ], ], 'TrainingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$Environment' => 'The environment variables to set in the Docker container.
', 'DescribeTrainingJobResponse$Environment' => 'The environment variables to set in the Docker container.
', 'TrainingJob$Environment' => 'The environment variables to set in the Docker container.
', ], ], 'TrainingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$value' => NULL, ], ], 'TrainingImageConfig' => [ 'base' => 'The configuration to use an image from a private Docker registry for a training job.
', 'refs' => [ 'AlgorithmSpecification$TrainingImageConfig' => 'The configuration to use an image from a private Docker registry for a training job.
', ], ], 'TrainingInputMode' => [ 'base' => '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.
(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.
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 number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
Specifies the number of instances of the instance group.
', 'ResourceConfig$InstanceCount' => 'The number of ML compute instances to use. For distributed training, provide a value greater than 1.
', ], ], 'TrainingInstanceType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceType' => '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.
', 'HyperParameterTuningResourceConfig$InstanceType' => 'The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.
', 'InstanceGroup$InstanceType' => 'Specifies the instance type of the instance group.
', 'ResourceConfig$InstanceType' => 'The 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.
A list of the instance types that this algorithm can use for training.
', ], ], 'TrainingJob' => [ 'base' => 'Contains information about a training job.
', 'refs' => [ 'SearchRecord$TrainingJob' => 'The properties of a training job.
', 'TrialComponentSourceDetail$TrainingJob' => 'Information about a training job that\'s the source of a trial component.
', ], ], 'TrainingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobResponse$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'DescribeProcessingJobResponse$TrainingJobArn' => 'The ARN of a training job associated with this processing job.
', 'DescribeTrainingJobResponse$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'HyperParameterTrainingJobSummary$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'ProcessingJob$TrainingJobArn' => 'The ARN of the training job associated with this processing job.
', 'TrainingJob$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'TrainingJobStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the training job that was run by this step execution.
', 'TrainingJobSummary$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', 'UpdateTrainingJobResponse$TrainingJobArn' => 'The Amazon Resource Name (ARN) of the training job.
', ], ], 'TrainingJobDefinition' => [ 'base' => 'Defines the input needed to run a training job using the algorithm.
', 'refs' => [ 'AlgorithmValidationProfile$TrainingJobDefinition' => 'The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.
Specifies 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.
The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
', 'DescribeTrainingJobRequest$TrainingJobName' => 'The name of the training job.
', 'DescribeTrainingJobResponse$TrainingJobName' => 'Name of the model training job.
', 'HyperParameterTrainingJobSummary$TrainingJobName' => 'The name of the training job.
', 'StopTrainingJobRequest$TrainingJobName' => 'The name of the training job to stop.
', 'TrainingJob$TrainingJobName' => 'The name of the training job.
', 'TrainingJobSummary$TrainingJobName' => 'The name of the training job that you want a summary for.
', 'UpdateTrainingJobRequest$TrainingJobName' => 'The name of a training job to update the Debugger profiling configuration.
', 'WarmPoolStatus$ReusedByJob' => 'The name of the matching training job that reused the warm pool.
', ], ], 'TrainingJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobRequest$SortBy' => '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.
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.
The status of the training job.
', 'ListTrainingJobsForHyperParameterTuningJobRequest$StatusEquals' => 'A filter that returns only training jobs with the specified status.
', 'ListTrainingJobsRequest$StatusEquals' => 'A filter that retrieves only training jobs with a specific status.
', 'TrainingJob$TrainingJobStatus' => '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.
The status of the training job.
', ], ], 'TrainingJobStatusCounter' => [ 'base' => NULL, 'refs' => [ 'TrainingJobStatusCounters$Completed' => 'The number of completed training jobs launched by the hyperparameter tuning job.
', 'TrainingJobStatusCounters$InProgress' => 'The number of in-progress training jobs launched by a hyperparameter tuning job.
', 'TrainingJobStatusCounters$RetryableError' => '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.
', 'TrainingJobStatusCounters$NonRetryableError' => '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.
', 'TrainingJobStatusCounters$Stopped' => 'The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
', ], ], 'TrainingJobStatusCounters' => [ 'base' => 'The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.
', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters' => 'The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
', 'HyperParameterTuningJobSearchEntity$TrainingJobStatusCounters' => NULL, 'HyperParameterTuningJobSummary$TrainingJobStatusCounters' => 'The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
', ], ], 'TrainingJobStepMetadata' => [ 'base' => 'Metadata for a training job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$TrainingJob' => 'The Amazon Resource Name (ARN) of the training job that was run by this step execution.
', ], ], 'TrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsResponse$TrainingJobSummaries' => 'An array of TrainingJobSummary objects, each listing a training job.
Provides summary information about a training job.
', 'refs' => [ 'TrainingJobSummaries$member' => NULL, ], ], 'TrainingRepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAccessMode' => '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.
', 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAuthConfig' => 'An object containing authentication information for a private Docker registry containing your training images.
', ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'TrainingRepositoryAuthConfig$TrainingRepositoryCredentialsProviderArn' => 'The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access credentials to your private Docker registry.
', ], ], 'TrainingSpecification' => [ 'base' => 'Defines how the algorithm is used for a training job.
', 'refs' => [ 'CreateAlgorithmInput$TrainingSpecification' => '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.
Details about training jobs run by this algorithm.
', ], ], 'TrainingTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingTimeInSeconds' => 'The training time in seconds.
', 'TrainingJob$TrainingTimeInSeconds' => 'The training time in seconds.
', ], ], 'TransformDataSource' => [ 'base' => 'Describes the location of the channel data.
', 'refs' => [ 'TransformInput$DataSource' => 'Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
', ], ], 'TransformEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$key' => NULL, ], ], 'TransformEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$Environment' => 'The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
', 'DescribeTransformJobResponse$Environment' => 'The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
', 'TransformJob$Environment' => 'The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
', 'TransformJobDefinition$Environment' => 'The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
', ], ], 'TransformEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$value' => NULL, ], ], 'TransformInput' => [ 'base' => 'Describes the input source of a transform job and the way the transform job consumes it.
', 'refs' => [ 'CreateTransformJobRequest$TransformInput' => 'Describes the input source and the way the transform job consumes it.
', 'DescribeTransformJobResponse$TransformInput' => 'Describes the dataset to be transformed and the Amazon S3 location where it is stored.
', 'TransformJob$TransformInput' => NULL, 'TransformJobDefinition$TransformInput' => 'A description of the input source and the way the transform job consumes it.
', ], ], 'TransformInstanceCount' => [ 'base' => NULL, 'refs' => [ 'TransformResources$InstanceCount' => '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 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.
A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
', 'InferenceSpecification$SupportedTransformInstanceTypes' => '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.
', ], ], 'TransformJob' => [ 'base' => 'A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.
', 'refs' => [ 'ModelDashboardModel$LastBatchTransformJob' => NULL, 'TrialComponentSourceDetail$TransformJob' => 'Information about a transform job that\'s the source of a trial component.
', ], ], 'TransformJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobResponse$TransformJobArn' => 'The Amazon Resource Name (ARN) of the transform job.
', 'DescribeTransformJobResponse$TransformJobArn' => 'The Amazon Resource Name (ARN) of the transform job.
', 'TransformJob$TransformJobArn' => 'The Amazon Resource Name (ARN) of the transform job.
', 'TransformJobStepMetadata$Arn' => 'The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
', 'TransformJobSummary$TransformJobArn' => 'The Amazon Resource Name (ARN) of the transform job.
', ], ], 'TransformJobDefinition' => [ 'base' => 'Defines the input needed to run a transform job using the inference specification specified in the algorithm.
', 'refs' => [ 'AlgorithmValidationProfile$TransformJobDefinition' => 'The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.
The TransformJobDefinition object that describes the transform job used for the validation of the model package.
The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
', 'DescribeTransformJobRequest$TransformJobName' => 'The name of the transform job that you want to view details of.
', 'DescribeTransformJobResponse$TransformJobName' => 'The name of the transform job.
', 'StopTransformJobRequest$TransformJobName' => 'The name of the batch transform job to stop.
', 'TransformJob$TransformJobName' => 'The name of the transform job.
', 'TransformJobSummary$TransformJobName' => 'The name of the transform job.
', ], ], 'TransformJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTransformJobResponse$TransformJobStatus' => 'The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.
A filter that retrieves only transform jobs with a specific status.
', 'TransformJob$TransformJobStatus' => '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 status of the transform job.
', ], ], 'TransformJobStepMetadata' => [ 'base' => 'Metadata for a transform job step.
', 'refs' => [ 'PipelineExecutionStepMetadata$TransformJob' => 'The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
', ], ], 'TransformJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTransformJobsResponse$TransformJobSummaries' => 'An array of TransformJobSummary objects.
Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.
Describes the results of a transform job.
', 'refs' => [ 'CreateTransformJobRequest$TransformOutput' => 'Describes the results of the transform job.
', 'DescribeTransformJobResponse$TransformOutput' => 'Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
', 'TransformJob$TransformOutput' => NULL, 'TransformJobDefinition$TransformOutput' => 'Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
', ], ], 'TransformResources' => [ 'base' => 'Describes the resources, including ML instance types and ML instance count, to use for transform job.
', 'refs' => [ 'CreateTransformJobRequest$TransformResources' => 'Describes the resources, including ML instance types and ML instance count, to use for the transform job.
', 'DescribeTransformJobResponse$TransformResources' => 'Describes the resources, including ML instance types and ML instance count, to use for the transform job.
', 'TransformJob$TransformResources' => NULL, 'TransformJobDefinition$TransformResources' => 'Identifies the ML compute instances for the transform job.
', ], ], 'TransformS3DataSource' => [ 'base' => 'Describes the S3 data source.
', 'refs' => [ 'TransformDataSource$S3DataSource' => 'The S3 location of the data source that is associated with a channel.
', ], ], 'TransformationAttributeName' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$key' => NULL, 'FillingTransformations$key' => NULL, ], ], 'Trial' => [ 'base' => 'The properties of a trial as returned by the Search API.
', 'refs' => [ 'SearchRecord$Trial' => 'The properties of a trial.
', ], ], 'TrialArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'CreateTrialResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'DeleteTrialResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial that is being deleted.
', 'DescribeTrialResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'DisassociateTrialComponentResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'Trial$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'TrialSummary$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', 'UpdateTrialResponse$TrialArn' => 'The Amazon Resource Name (ARN) of the trial.
', ], ], 'TrialComponent' => [ 'base' => 'The properties of a trial component as returned by the Search API.
', 'refs' => [ 'SearchRecord$TrialComponent' => 'The properties of a trial component.
', ], ], 'TrialComponentArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'CreateTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'DeleteTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the component is being deleted.
', 'DescribeTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'DisassociateTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'TrialComponent$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'TrialComponentSimpleSummary$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'TrialComponentSummary$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', 'UpdateTrialComponentResponse$TrialComponentArn' => 'The Amazon Resource Name (ARN) of the trial component.
', ], ], 'TrialComponentArtifact' => [ 'base' => '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.
', 'refs' => [ 'TrialComponentArtifacts$value' => NULL, ], ], 'TrialComponentArtifactValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$Value' => 'The location of the artifact.
', ], ], 'TrialComponentArtifacts' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$InputArtifacts' => 'The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
', 'CreateTrialComponentRequest$OutputArtifacts' => 'The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
', 'DescribeTrialComponentResponse$InputArtifacts' => 'The input artifacts of the component.
', 'DescribeTrialComponentResponse$OutputArtifacts' => 'The output artifacts of the component.
', 'TrialComponent$InputArtifacts' => 'The input artifacts of the component.
', 'TrialComponent$OutputArtifacts' => 'The output artifacts of the component.
', 'UpdateTrialComponentRequest$InputArtifacts' => 'Replaces all of the component\'s input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
', 'UpdateTrialComponentRequest$OutputArtifacts' => 'Replaces all of the component\'s output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
', ], ], 'TrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentKey256$member' => NULL, 'TrialComponentParameters$key' => NULL, ], ], 'TrialComponentKey64' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifacts$key' => NULL, ], ], 'TrialComponentMetricSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Metrics' => 'The metrics for the component.
', 'TrialComponent$Metrics' => 'The metrics for the component.
', ], ], 'TrialComponentMetricSummary' => [ 'base' => 'A summary of the metrics of a trial component.
', 'refs' => [ 'TrialComponentMetricSummaries$member' => NULL, ], ], 'TrialComponentParameterValue' => [ 'base' => 'The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.
This object is specified in the CreateTrialComponent request.
', 'refs' => [ 'TrialComponentParameters$value' => NULL, ], ], 'TrialComponentParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$Parameters' => 'The hyperparameters for the component.
', 'DescribeTrialComponentResponse$Parameters' => 'The hyperparameters of the component.
', 'TrialComponent$Parameters' => 'The hyperparameters of the component.
', 'UpdateTrialComponentRequest$Parameters' => 'Replaces all of the component\'s hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
', ], ], 'TrialComponentPrimaryStatus' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$PrimaryStatus' => 'The status of the trial component.
', ], ], 'TrialComponentSimpleSummaries' => [ 'base' => NULL, 'refs' => [ 'Trial$TrialComponentSummaries' => 'A list of the components associated with the trial. For each component, a summary of the component\'s properties is included.
', ], ], 'TrialComponentSimpleSummary' => [ 'base' => 'A short summary of a trial component.
', 'refs' => [ 'TrialComponentSimpleSummaries$member' => NULL, ], ], 'TrialComponentSource' => [ 'base' => 'The Amazon Resource Name (ARN) and job type of the source of a trial component.
', 'refs' => [ 'DescribeTrialComponentResponse$Source' => 'The Amazon Resource Name (ARN) of the source and, optionally, the job type.
', 'TrialComponent$Source' => 'The Amazon Resource Name (ARN) and job type of the source of the component.
', 'TrialComponentSimpleSummary$TrialComponentSource' => NULL, 'TrialComponentSources$member' => NULL, 'TrialComponentSummary$TrialComponentSource' => NULL, ], ], 'TrialComponentSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$SourceArn' => 'The Amazon Resource Name (ARN) of the source.
', 'TrialComponentSource$SourceArn' => 'The source Amazon Resource Name (ARN).
', 'TrialComponentSourceDetail$SourceArn' => 'The Amazon Resource Name (ARN) of the source.
', ], ], 'TrialComponentSourceDetail' => [ 'base' => 'Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.
Details of the source of the component.
', ], ], 'TrialComponentSources' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Sources' => 'A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
', ], ], 'TrialComponentStatus' => [ 'base' => 'The status of the trial component.
', 'refs' => [ 'CreateTrialComponentRequest$Status' => 'The status of the component. States include:
InProgress
Completed
Failed
The status of the component. States include:
InProgress
Completed
Failed
The status of the component. States include:
InProgress
Completed
Failed
The new status of the component.
', ], ], 'TrialComponentStatusMessage' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$Message' => 'If the component failed, a message describing why.
', ], ], 'TrialComponentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsResponse$TrialComponentSummaries' => 'A list of the summaries of your trial components.
', ], ], 'TrialComponentSummary' => [ 'base' => 'A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.
The source of the trial.
', 'refs' => [ 'DescribeTrialResponse$Source' => 'The Amazon Resource Name (ARN) of the source and, optionally, the job type.
', 'Trial$Source' => NULL, 'TrialSummary$TrialSource' => NULL, ], ], 'TrialSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialSource$SourceArn' => 'The Amazon Resource Name (ARN) of the source.
', ], ], 'TrialSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialsResponse$TrialSummaries' => 'A list of the summaries of your trials.
', ], ], 'TrialSummary' => [ 'base' => 'A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.
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.
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.
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.
TtlDuration time unit.
TtlDuration time value.
The job completion criteria.
', 'refs' => [ 'HyperParameterTuningJobConfig$TuningJobCompletionCriteria' => 'The tuning job\'s completion criteria.
', ], ], 'TuningJobStepMetaData' => [ 'base' => 'Metadata for a tuning step.
', 'refs' => [ 'PipelineExecutionStepMetadata$TuningJob' => 'The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
', ], ], 'USD' => [ 'base' => 'Represents an amount of money in United States dollars.
', 'refs' => [ 'PublicWorkforceTaskPrice$AmountInUsd' => 'Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.
', ], ], 'UiConfig' => [ 'base' => '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.
Information about the user interface that workers use to complete the labeling task.
', ], ], 'UiTemplate' => [ 'base' => 'The Liquid template for the worker user interface.
', 'refs' => [ 'CreateHumanTaskUiRequest$UiTemplate' => NULL, 'RenderUiTemplateRequest$UiTemplate' => 'A Template object containing the worker UI template to render.
Container for user interface template information.
', 'refs' => [ 'DescribeHumanTaskUiResponse$UiTemplate' => NULL, ], ], 'UpdateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$ModelDataUrl' => 'The location of the model artifacts. For more information, see ContainerDefinition.
', 'ClarifyShapBaselineConfig$ShapBaselineUri' => '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 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.
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).
The model artifacts must be in an S3 bucket that is in the same region as the model package.
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).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
', 'refs' => [ 'AssociationSummary$CreatedBy' => NULL, 'DescribeActionResponse$CreatedBy' => NULL, 'DescribeActionResponse$LastModifiedBy' => NULL, 'DescribeArtifactResponse$CreatedBy' => NULL, 'DescribeArtifactResponse$LastModifiedBy' => NULL, 'DescribeContextResponse$CreatedBy' => NULL, 'DescribeContextResponse$LastModifiedBy' => NULL, 'DescribeExperimentResponse$CreatedBy' => 'Who created the experiment.
', 'DescribeExperimentResponse$LastModifiedBy' => 'Who last modified the experiment.
', 'DescribeLineageGroupResponse$CreatedBy' => NULL, 'DescribeLineageGroupResponse$LastModifiedBy' => NULL, 'DescribeModelCardResponse$CreatedBy' => NULL, 'DescribeModelCardResponse$LastModifiedBy' => NULL, 'DescribeModelPackageGroupOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$LastModifiedBy' => NULL, 'DescribePipelineExecutionResponse$CreatedBy' => NULL, 'DescribePipelineExecutionResponse$LastModifiedBy' => NULL, 'DescribePipelineResponse$CreatedBy' => NULL, 'DescribePipelineResponse$LastModifiedBy' => NULL, 'DescribeProjectOutput$CreatedBy' => NULL, 'DescribeProjectOutput$LastModifiedBy' => NULL, 'DescribeTrialComponentResponse$CreatedBy' => 'Who created the trial component.
', 'DescribeTrialComponentResponse$LastModifiedBy' => 'Who last modified the component.
', 'DescribeTrialResponse$CreatedBy' => 'Who created the trial.
', 'DescribeTrialResponse$LastModifiedBy' => 'Who last modified the trial.
', 'Experiment$CreatedBy' => 'Who created the experiment.
', 'Experiment$LastModifiedBy' => NULL, 'ModelCard$CreatedBy' => NULL, 'ModelCard$LastModifiedBy' => NULL, 'ModelDashboardModelCard$CreatedBy' => NULL, 'ModelDashboardModelCard$LastModifiedBy' => NULL, 'ModelPackage$CreatedBy' => 'Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
', 'ModelPackage$LastModifiedBy' => 'Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
', 'ModelPackageGroup$CreatedBy' => NULL, 'Pipeline$CreatedBy' => NULL, 'Pipeline$LastModifiedBy' => NULL, 'PipelineExecution$CreatedBy' => NULL, 'PipelineExecution$LastModifiedBy' => NULL, 'Project$CreatedBy' => 'Who created the project.
', 'Project$LastModifiedBy' => NULL, 'Trial$CreatedBy' => 'Who created the trial.
', 'Trial$LastModifiedBy' => NULL, 'TrialComponent$CreatedBy' => 'Who created the trial component.
', 'TrialComponent$LastModifiedBy' => NULL, 'TrialComponentSimpleSummary$CreatedBy' => NULL, 'TrialComponentSummary$CreatedBy' => 'Who created the trial component.
', 'TrialComponentSummary$LastModifiedBy' => 'Who last modified the component.
', ], ], 'UserProfileArn' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileResponse$UserProfileArn' => 'The user profile Amazon Resource Name (ARN).
', 'DescribeUserProfileResponse$UserProfileArn' => 'The user profile Amazon Resource Name (ARN).
', 'UpdateUserProfileResponse$UserProfileArn' => 'The user profile Amazon Resource Name (ARN).
', ], ], 'UserProfileDetails' => [ 'base' => 'The user profile details.
', 'refs' => [ 'UserProfileList$member' => NULL, ], ], 'UserProfileList' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesResponse$UserProfiles' => 'The list of user profiles.
', ], ], 'UserProfileName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$UserProfileName' => 'The user profile name.
', 'CreateAppRequest$UserProfileName' => 'The user profile name. If this value is not set, then SpaceName must be set.
The name of the UserProfile to sign-in as.
', 'CreateUserProfileRequest$UserProfileName' => 'A name for the UserProfile. This value is not case sensitive.
', 'DeleteAppRequest$UserProfileName' => 'The user profile name. If this value is not set, then SpaceName must be set.
The user profile name.
', 'DescribeAppRequest$UserProfileName' => 'The user profile name. If this value is not set, then SpaceName must be set.
The user profile name.
', 'DescribeUserProfileRequest$UserProfileName' => 'The user profile name. This value is not case sensitive.
', 'DescribeUserProfileResponse$UserProfileName' => 'The user profile name.
', 'ListAppsRequest$UserProfileNameEquals' => 'A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.
A parameter by which to filter the results.
', 'UpdateUserProfileRequest$UserProfileName' => 'The user profile name.
', 'UserProfileDetails$UserProfileName' => 'The user profile name.
', ], ], 'UserProfileSortKey' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesRequest$SortBy' => 'The parameter by which to sort the results. The default is CreationTime.
', ], ], 'UserProfileStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeUserProfileResponse$Status' => 'The status.
', 'UserProfileDetails$Status' => 'The status.
', ], ], 'UserSettings' => [ 'base' => 'A collection of settings that apply to users of Amazon SageMaker Studio. 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 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.
A collection of settings.
', 'DescribeDomainResponse$DefaultUserSettings' => 'Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
', 'DescribeUserProfileResponse$UserSettings' => 'A collection of settings.
', 'UpdateDomainRequest$DefaultUserSettings' => 'A collection of settings.
', 'UpdateUserProfileRequest$UserSettings' => 'A collection of settings.
', ], ], 'UsersPerStep' => [ 'base' => NULL, 'refs' => [ 'Stairs$UsersPerStep' => 'Specifies how many new users to spawn in each step.
', ], ], 'UtilizationMetric' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$CpuUtilization' => '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.
NaN indicates that the value is not available.
The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.
', 'GetScalingConfigurationRecommendationResponse$TargetCpuUtilizationPerCore' => 'The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.
', ], ], 'ValidationFraction' => [ 'base' => NULL, 'refs' => [ 'AutoMLDataSplitConfig$ValidationFraction' => '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.
', ], ], 'VariantName' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$VariantName' => 'The name of the variant to update.
', 'PendingProductionVariantSummary$VariantName' => 'The name of the variant.
', 'ProductionVariant$VariantName' => 'The name of the production variant.
', 'ProductionVariantSummary$VariantName' => 'The name of the variant.
', ], ], 'VariantProperty' => [ 'base' => '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.
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 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.)
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.
A message that describes the status of the production variant.
', ], ], 'VariantWeight' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredWeight' => 'The variant\'s weight.
', 'PendingProductionVariantSummary$CurrentWeight' => 'The weight associated with the variant.
', 'PendingProductionVariantSummary$DesiredWeight' => '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.
', 'ProductionVariant$InitialVariantWeight' => '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.
The weight associated with the variant.
', 'ProductionVariantSummary$DesiredWeight' => 'The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
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.
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.
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.
Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
', ], ], 'VersionedArnOrName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ModelPackageName' => 'The name or Amazon Resource Name (ARN) of the model package to use to create the model.
', 'DeleteModelPackageInput$ModelPackageName' => '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).
', 'DescribeModelPackageInput$ModelPackageName' => '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).
', ], ], 'Vertex' => [ 'base' => 'A lineage entity connected to the starting entity(ies).
', 'refs' => [ 'Vertices$member' => NULL, ], ], 'Vertices' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Vertices' => 'A list of vertices connected to the start entity(ies) in the lineage graph.
', ], ], 'VolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$VolumeSizeInGB' => 'The volume size in GB of the data to be processed for hyperparameter optimization (optional).
', 'ResourceConfig$VolumeSizeInGB' => '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.
', ], ], 'VpcConfig' => [ 'base' => 'Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.
', 'refs' => [ 'AutoMLSecurityConfig$VpcConfig' => 'The VPC configuration.
', 'CreateModelInput$VpcConfig' => '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.
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.
', 'DescribeModelOutput$VpcConfig' => '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
', 'DescribeTrainingJobResponse$VpcConfig' => '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.
', 'HyperParameterTrainingJobDefinition$VpcConfig' => '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.
', 'LabelingJobResourceConfig$VpcConfig' => NULL, 'Model$VpcConfig' => NULL, 'MonitoringNetworkConfig$VpcConfig' => NULL, 'NetworkConfig$VpcConfig' => NULL, 'TrainingJob$VpcConfig' => '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.
', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$VpcId' => 'The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
', 'DescribeDomainResponse$VpcId' => 'The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
', ], ], 'VpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SecurityGroupIds' => '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 length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.
', 'TrafficRoutingConfig$WaitIntervalInSeconds' => 'The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
', ], ], 'WarmPoolResourceStatus' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsRequest$WarmPoolStatusEquals' => 'A filter that retrieves only training jobs with a specific warm pool status.
', 'WarmPoolStatus$Status' => '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.
Status and billing information about the warm pool.
', 'refs' => [ 'DescribeTrainingJobResponse$WarmPoolStatus' => 'The status of the warm pool associated with the training job.
', 'TrainingJobSummary$WarmPoolStatus' => 'The status of the warm pool associated with the training job.
', ], ], 'Workforce' => [ 'base' => '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.
', 'refs' => [ 'DescribeWorkforceResponse$Workforce' => '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.
', 'UpdateWorkforceResponse$Workforce' => '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.
', 'Workforces$member' => NULL, ], ], 'WorkforceArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceResponse$WorkforceArn' => 'The Amazon Resource Name (ARN) of the workforce.
', 'Workforce$WorkforceArn' => 'The Amazon Resource Name (ARN) of the private workforce.
', 'Workteam$WorkforceArn' => 'The Amazon Resource Name (ARN) of the workforce.
', ], ], 'WorkforceFailureReason' => [ 'base' => NULL, 'refs' => [ 'Workforce$FailureReason' => 'The reason your workforce failed.
', ], ], 'WorkforceName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceRequest$WorkforceName' => 'The name of the private workforce.
', 'CreateWorkteamRequest$WorkforceName' => 'The name of the workforce.
', 'DeleteWorkforceRequest$WorkforceName' => 'The name of the workforce.
', 'DescribeWorkforceRequest$WorkforceName' => '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 filter you can use to search for workforces using part of the workforce name.
', 'UpdateWorkforceRequest$WorkforceName' => 'The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.
', 'Workforce$WorkforceName' => 'The name of the private workforce.
', ], ], 'WorkforceSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSecurityGroupIds$member' => NULL, ], ], 'WorkforceSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$SecurityGroupIds' => 'The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
', 'WorkforceVpcConfigResponse$SecurityGroupIds' => 'The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
', ], ], 'WorkforceStatus' => [ 'base' => NULL, 'refs' => [ 'Workforce$Status' => 'The status of your workforce.
', ], ], 'WorkforceSubnetId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSubnets$member' => NULL, ], ], 'WorkforceSubnets' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$Subnets' => 'The ID of the subnets in the VPC that you want to connect.
', 'WorkforceVpcConfigResponse$Subnets' => 'The ID of the subnets in the VPC that you want to connect.
', ], ], 'WorkforceVpcConfigRequest' => [ 'base' => 'The VPC object you use to create or update a workforce.
', 'refs' => [ 'CreateWorkforceRequest$WorkforceVpcConfig' => 'Use this parameter to configure a workforce using VPC.
', 'UpdateWorkforceRequest$WorkforceVpcConfig' => 'Use this parameter to update your VPC configuration for a workforce.
', ], ], 'WorkforceVpcConfigResponse' => [ 'base' => 'A VpcConfig object that specifies the VPC that you want your workforce to connect to.
', 'refs' => [ 'Workforce$WorkforceVpcConfig' => 'The configuration of a VPC workforce.
', ], ], 'WorkforceVpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigResponse$VpcEndpointId' => 'The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.
', ], ], 'WorkforceVpcId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$VpcId' => 'The ID of the VPC that the workforce uses for communication.
', 'WorkforceVpcConfigResponse$VpcId' => 'The ID of the VPC that the workforce uses for communication.
', ], ], 'Workforces' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesResponse$Workforces' => 'A list containing information about your workforce.
', ], ], 'WorkspaceSettings' => [ 'base' => 'The workspace settings for the SageMaker Canvas application.
', 'refs' => [ 'CanvasAppSettings$WorkspaceSettings' => 'The workspace settings for the SageMaker Canvas application.
', ], ], 'Workteam' => [ 'base' => 'Provides details about a labeling work team.
', 'refs' => [ 'DescribeWorkteamResponse$Workteam' => 'A Workteam instance that contains information about the work team.
A Workteam object that describes the updated work team.
The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.
', 'DescribeSubscribedWorkteamRequest$WorkteamArn' => 'The Amazon Resource Name (ARN) of the subscribed work team to describe.
', 'HumanLoopConfig$WorkteamArn' => '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.
', 'HumanTaskConfig$WorkteamArn' => 'The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.
', 'LabelingJobSummary$WorkteamArn' => 'The Amazon Resource Name (ARN) of the work team assigned to the job.
', 'ListLabelingJobsForWorkteamRequest$WorkteamArn' => 'The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
', 'SubscribedWorkteam$WorkteamArn' => 'The Amazon Resource Name (ARN) of the vendor that you have subscribed.
', 'Workteam$WorkteamArn' => 'The Amazon Resource Name (ARN) that identifies the work team.
', ], ], 'WorkteamName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$WorkteamName' => 'The name of the work team. Use this name to identify the work team.
', 'DeleteWorkteamRequest$WorkteamName' => 'The name of the work team to delete.
', 'DescribeWorkteamRequest$WorkteamName' => 'The name of the work team to return a description of.
', 'ListSubscribedWorkteamsRequest$NameContains' => 'A string in the work team name. This filter returns only work teams whose name contains the specified string.
', 'ListWorkteamsRequest$NameContains' => 'A string in the work team\'s name. This filter returns only work teams whose name contains the specified string.
', 'UpdateWorkteamRequest$WorkteamName' => 'The name of the work team to update.
', 'Workteam$WorkteamName' => 'The name of the work team.
', ], ], 'Workteams' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsResponse$Workteams' => 'An array of Workteam objects, each describing a work team.