2021/11/08 - Amazon SageMaker Service - 4 updated api methods
Changes SageMaker CreateEndpoint and UpdateEndpoint APIs now support additional deployment configuration to manage traffic shifting options and automatic rollback monitoring. DescribeEndpoint now shows new in-progress deployment details with stage status.
{'DeploymentConfig': {'AutoRollbackConfiguration': {'Alarms': [{'AlarmName': 'string'}]}, 'BlueGreenUpdatePolicy': {'MaximumExecutionTimeoutInSeconds': 'integer', 'TerminationWaitInSeconds': 'integer', 'TrafficRoutingConfiguration': {'CanarySize': {'Type': 'INSTANCE_COUNT ' '| ' 'CAPACITY_PERCENT', 'Value': 'integer'}, 'LinearStepSize': {'Type': 'INSTANCE_COUNT ' '| ' 'CAPACITY_PERCENT', 'Value': 'integer'}, 'Type': 'ALL_AT_ONCE ' '| ' 'CANARY ' '| ' 'LINEAR', 'WaitIntervalInSeconds': 'integer'}}}}
Creates an endpoint using the endpoint configuration specified in the request. Amazon 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 Amazon SageMaker hosting services.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see the Create Endpoint example notebook.
Note
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, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
Note
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 Amazon SageMaker receives the request, it sets the endpoint status to Creating . After it creates the endpoint, it sets the status to InService . Amazon 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, Amazon 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 IAM user 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 .
Note
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.
See also: AWS API Documentation
Request Syntax
client.create_endpoint( EndpointName='string', EndpointConfigName='string', DeploymentConfig={ 'BlueGreenUpdatePolicy': { 'TrafficRoutingConfiguration': { 'Type': 'ALL_AT_ONCE'|'CANARY'|'LINEAR', 'WaitIntervalInSeconds': 123, 'CanarySize': { 'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENT', 'Value': 123 }, 'LinearStepSize': { 'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENT', 'Value': 123 } }, 'TerminationWaitInSeconds': 123, 'MaximumExecutionTimeoutInSeconds': 123 }, 'AutoRollbackConfiguration': { 'Alarms': [ { 'AlarmName': 'string' }, ] } }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] )
string
[REQUIRED]
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 .
string
[REQUIRED]
The name of an endpoint configuration. For more information, see CreateEndpointConfig.
dict
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
BlueGreenUpdatePolicy (dict) -- [REQUIRED]
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.
TrafficRoutingConfiguration (dict) -- [REQUIRED]
Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.
Type (string) -- [REQUIRED]
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.
WaitIntervalInSeconds (integer) -- [REQUIRED]
The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
CanarySize (dict) --
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.
Type (string) -- [REQUIRED]
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.
Value (integer) -- [REQUIRED]
Defines the capacity size, either as a number of instances or a capacity percentage.
LinearStepSize (dict) --
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.
Type (string) -- [REQUIRED]
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.
Value (integer) -- [REQUIRED]
Defines the capacity size, either as a number of instances or a capacity percentage.
TerminationWaitInSeconds (integer) --
Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.
MaximumExecutionTimeoutInSeconds (integer) --
Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds .
AutoRollbackConfiguration (dict) --
Automatic rollback configuration for handling endpoint deployment failures and recovery.
Alarms (list) --
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.
(dict) --
An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
AlarmName (string) --
The name of a CloudWatch alarm in your account.
list
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.
(dict) --
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.
Key (string) -- [REQUIRED]
The tag key. Tag keys must be unique per resource.
Value (string) -- [REQUIRED]
The tag value.
dict
Response Syntax
{ 'EndpointArn': 'string' }
Response Structure
(dict) --
EndpointArn (string) --
The Amazon Resource Name (ARN) of the endpoint.
{'LastDeploymentConfig': {'BlueGreenUpdatePolicy': {'TrafficRoutingConfiguration': {'LinearStepSize': {'Type': 'INSTANCE_COUNT ' '| ' 'CAPACITY_PERCENT', 'Value': 'integer'}, 'Type': {'LINEAR'}}}}, 'PendingDeploymentSummary': {'EndpointConfigName': 'string', 'ProductionVariants': [{'AcceleratorType': 'ml.eia1.medium ' '| ' 'ml.eia1.large ' '| ' 'ml.eia1.xlarge ' '| ' 'ml.eia2.medium ' '| ' 'ml.eia2.large ' '| ' 'ml.eia2.xlarge', 'CurrentInstanceCount': 'integer', 'CurrentWeight': 'float', 'DeployedImages': [{'ResolutionTime': 'timestamp', 'ResolvedImage': 'string', 'SpecifiedImage': 'string'}], 'DesiredInstanceCount': 'integer', 'DesiredWeight': 'float', 'InstanceType': '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', 'VariantName': 'string', 'VariantStatus': [{'StartTime': 'timestamp', 'Status': 'Creating ' '| ' 'Updating ' '| ' 'Deleting ' '| ' 'ActivatingTraffic ' '| ' 'Baking', 'StatusMessage': 'string'}]}], 'StartTime': 'timestamp'}, 'ProductionVariants': {'VariantStatus': [{'StartTime': 'timestamp', 'Status': 'Creating | Updating | ' 'Deleting | ' 'ActivatingTraffic | ' 'Baking', 'StatusMessage': 'string'}]}}
Returns the description of an endpoint.
See also: AWS API Documentation
Request Syntax
client.describe_endpoint( EndpointName='string' )
string
[REQUIRED]
The name of the endpoint.
dict
Response Syntax
{ 'EndpointName': 'string', 'EndpointArn': 'string', 'EndpointConfigName': 'string', 'ProductionVariants': [ { 'VariantName': 'string', 'DeployedImages': [ { 'SpecifiedImage': 'string', 'ResolvedImage': 'string', 'ResolutionTime': datetime(2015, 1, 1) }, ], 'CurrentWeight': ..., 'DesiredWeight': ..., 'CurrentInstanceCount': 123, 'DesiredInstanceCount': 123, 'VariantStatus': [ { 'Status': 'Creating'|'Updating'|'Deleting'|'ActivatingTraffic'|'Baking', 'StatusMessage': 'string', 'StartTime': datetime(2015, 1, 1) }, ] }, ], 'DataCaptureConfig': { 'EnableCapture': True|False, 'CaptureStatus': 'Started'|'Stopped', 'CurrentSamplingPercentage': 123, 'DestinationS3Uri': 'string', 'KmsKeyId': 'string' }, 'EndpointStatus': 'OutOfService'|'Creating'|'Updating'|'SystemUpdating'|'RollingBack'|'InService'|'Deleting'|'Failed', 'FailureReason': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'LastDeploymentConfig': { 'BlueGreenUpdatePolicy': { 'TrafficRoutingConfiguration': { 'Type': 'ALL_AT_ONCE'|'CANARY'|'LINEAR', 'WaitIntervalInSeconds': 123, 'CanarySize': { 'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENT', 'Value': 123 }, 'LinearStepSize': { 'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENT', 'Value': 123 } }, 'TerminationWaitInSeconds': 123, 'MaximumExecutionTimeoutInSeconds': 123 }, 'AutoRollbackConfiguration': { 'Alarms': [ { 'AlarmName': 'string' }, ] } }, 'AsyncInferenceConfig': { 'ClientConfig': { 'MaxConcurrentInvocationsPerInstance': 123 }, 'OutputConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string', 'NotificationConfig': { 'SuccessTopic': 'string', 'ErrorTopic': 'string' } } }, 'PendingDeploymentSummary': { 'EndpointConfigName': 'string', 'ProductionVariants': [ { 'VariantName': 'string', 'DeployedImages': [ { 'SpecifiedImage': 'string', 'ResolvedImage': 'string', 'ResolutionTime': datetime(2015, 1, 1) }, ], 'CurrentWeight': ..., 'DesiredWeight': ..., 'CurrentInstanceCount': 123, 'DesiredInstanceCount': 123, 'InstanceType': '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', 'AcceleratorType': 'ml.eia1.medium'|'ml.eia1.large'|'ml.eia1.xlarge'|'ml.eia2.medium'|'ml.eia2.large'|'ml.eia2.xlarge', 'VariantStatus': [ { 'Status': 'Creating'|'Updating'|'Deleting'|'ActivatingTraffic'|'Baking', 'StatusMessage': 'string', 'StartTime': datetime(2015, 1, 1) }, ] }, ], 'StartTime': datetime(2015, 1, 1) } }
Response Structure
(dict) --
EndpointName (string) --
Name of the endpoint.
EndpointArn (string) --
The Amazon Resource Name (ARN) of the endpoint.
EndpointConfigName (string) --
The name of the endpoint configuration associated with this endpoint.
ProductionVariants (list) --
An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
(dict) --
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.
VariantName (string) --
The name of the variant.
DeployedImages (list) --
An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant .
(dict) --
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 .
SpecifiedImage (string) --
The image path you specified when you created the model.
ResolvedImage (string) --
The specific digest path of the image hosted in this ProductionVariant .
ResolutionTime (datetime) --
The date and time when the image path for the model resolved to the ResolvedImage
CurrentWeight (float) --
The weight associated with the variant.
DesiredWeight (float) --
The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
CurrentInstanceCount (integer) --
The number of instances associated with the variant.
DesiredInstanceCount (integer) --
The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
VariantStatus (list) --
The endpoint variant status which describes the current deployment stage status or operational status.
(dict) --
Describes the status of the production variant.
Status (string) --
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.
StatusMessage (string) --
A message that describes the status of the production variant.
StartTime (datetime) --
The start time of the current status change.
DataCaptureConfig (dict) --
EnableCapture (boolean) --
CaptureStatus (string) --
CurrentSamplingPercentage (integer) --
DestinationS3Uri (string) --
KmsKeyId (string) --
EndpointStatus (string) --
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.
FailureReason (string) --
If the status of the endpoint is Failed , the reason why it failed.
CreationTime (datetime) --
A timestamp that shows when the endpoint was created.
LastModifiedTime (datetime) --
A timestamp that shows when the endpoint was last modified.
LastDeploymentConfig (dict) --
The most recent deployment configuration for the endpoint.
BlueGreenUpdatePolicy (dict) --
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.
TrafficRoutingConfiguration (dict) --
Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.
Type (string) --
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.
WaitIntervalInSeconds (integer) --
The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
CanarySize (dict) --
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.
Type (string) --
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.
Value (integer) --
Defines the capacity size, either as a number of instances or a capacity percentage.
LinearStepSize (dict) --
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.
Type (string) --
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.
Value (integer) --
Defines the capacity size, either as a number of instances or a capacity percentage.
TerminationWaitInSeconds (integer) --
Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.
MaximumExecutionTimeoutInSeconds (integer) --
Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds .
AutoRollbackConfiguration (dict) --
Automatic rollback configuration for handling endpoint deployment failures and recovery.
Alarms (list) --
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.
(dict) --
An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
AlarmName (string) --
The name of a CloudWatch alarm in your account.
AsyncInferenceConfig (dict) --
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
ClientConfig (dict) --
Configures the behavior of the client used by Amazon SageMaker to interact with the model container during asynchronous inference.
MaxConcurrentInvocationsPerInstance (integer) --
The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, Amazon SageMaker will choose an optimal value for you.
OutputConfig (dict) --
Specifies the configuration for asynchronous inference invocation outputs.
KmsKeyId (string) --
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the asynchronous inference output in Amazon S3.
S3OutputPath (string) --
The Amazon S3 location to upload inference responses to.
NotificationConfig (dict) --
Specifies the configuration for notifications of inference results for asynchronous inference.
SuccessTopic (string) --
Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.
ErrorTopic (string) --
Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.
PendingDeploymentSummary (dict) --
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.
EndpointConfigName (string) --
The name of the endpoint configuration used in the deployment.
ProductionVariants (list) --
List of PendingProductionVariantSummary objects.
(dict) --
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.
VariantName (string) --
The name of the variant.
DeployedImages (list) --
An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant .
(dict) --
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 .
SpecifiedImage (string) --
The image path you specified when you created the model.
ResolvedImage (string) --
The specific digest path of the image hosted in this ProductionVariant .
ResolutionTime (datetime) --
The date and time when the image path for the model resolved to the ResolvedImage
CurrentWeight (float) --
The weight associated with the variant.
DesiredWeight (float) --
The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
CurrentInstanceCount (integer) --
The number of instances associated with the variant.
DesiredInstanceCount (integer) --
The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
InstanceType (string) --
The type of instances associated with the variant.
AcceleratorType (string) --
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.
VariantStatus (list) --
The endpoint variant status which describes the current deployment stage status or operational status.
(dict) --
Describes the status of the production variant.
Status (string) --
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.
StatusMessage (string) --
A message that describes the status of the production variant.
StartTime (datetime) --
The start time of the current status change.
StartTime (datetime) --
The start time of the deployment.
{'Results': {'Endpoint': {'ProductionVariants': {'VariantStatus': [{'StartTime': 'timestamp', 'Status': 'Creating ' '| ' 'Updating ' '| ' 'Deleting ' '| ' 'ActivatingTraffic ' '| ' 'Baking', 'StatusMessage': 'string'}]}}}}
Finds Amazon 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.
See also: AWS API Documentation
Request Syntax
client.search( Resource='TrainingJob'|'Experiment'|'ExperimentTrial'|'ExperimentTrialComponent'|'Endpoint'|'ModelPackage'|'ModelPackageGroup'|'Pipeline'|'PipelineExecution'|'FeatureGroup'|'Project', SearchExpression={ 'Filters': [ { 'Name': 'string', 'Operator': 'Equals'|'NotEquals'|'GreaterThan'|'GreaterThanOrEqualTo'|'LessThan'|'LessThanOrEqualTo'|'Contains'|'Exists'|'NotExists'|'In', 'Value': 'string' }, ], 'NestedFilters': [ { 'NestedPropertyName': 'string', 'Filters': [ { 'Name': 'string', 'Operator': 'Equals'|'NotEquals'|'GreaterThan'|'GreaterThanOrEqualTo'|'LessThan'|'LessThanOrEqualTo'|'Contains'|'Exists'|'NotExists'|'In', 'Value': 'string' }, ] }, ], 'SubExpressions': [ {'... recursive ...'}, ], 'Operator': 'And'|'Or' }, SortBy='string', SortOrder='Ascending'|'Descending', NextToken='string', MaxResults=123 )
string
[REQUIRED]
The name of the Amazon SageMaker resource to search for.
dict
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.
Filters (list) --
A list of filter objects.
(dict) --
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 , Amazon SageMaker uses the equals operator.
In search, there are several property types:
Metrics
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"
}
HyperParameters
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"
}
Tags
To define a tag filter, enter a value with the form Tags.<key> .
Name (string) -- [REQUIRED]
A resource property name. For example, TrainingJobName . For valid property names, see SearchRecord. You must specify a valid property for the resource.
Operator (string) --
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
Equals
The value of Name equals Value .
NotEquals
The value of Name doesn't equal Value .
Exists
The Name property exists.
NotExists
The Name property does not exist.
GreaterThan
The value of Name is greater than Value . Not supported for text properties.
GreaterThanOrEqualTo
The value of Name is greater than or equal to Value . Not supported for text properties.
LessThan
The value of Name is less than Value . Not supported for text properties.
LessThanOrEqualTo
The value of Name is less than or equal to Value . Not supported for text properties.
In
The value of Name is one of the comma delimited strings in Value . Only supported for text properties.
Contains
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. "
Value (string) --
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 .
NestedFilters (list) --
A list of nested filter objects.
(dict) --
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"}'
NestedPropertyName (string) -- [REQUIRED]
The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig .
Filters (list) -- [REQUIRED]
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 .
(dict) --
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 , Amazon SageMaker uses the equals operator.
In search, there are several property types:
Metrics
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"
}
HyperParameters
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"
}
Tags
To define a tag filter, enter a value with the form Tags.<key> .
Name (string) -- [REQUIRED]
A resource property name. For example, TrainingJobName . For valid property names, see SearchRecord. You must specify a valid property for the resource.
Operator (string) --
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
Equals
The value of Name equals Value .
NotEquals
The value of Name doesn't equal Value .
Exists
The Name property exists.
NotExists
The Name property does not exist.
GreaterThan
The value of Name is greater than Value . Not supported for text properties.
GreaterThanOrEqualTo
The value of Name is greater than or equal to Value . Not supported for text properties.
LessThan
The value of Name is less than Value . Not supported for text properties.
LessThanOrEqualTo
The value of Name is less than or equal to Value . Not supported for text properties.
In
The value of Name is one of the comma delimited strings in Value . Only supported for text properties.
Contains
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. "
Value (string) --
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 .
SubExpressions (list) --
A list of search expression objects.
(dict) --
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 .
Operator (string) --
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 .
string
The name of the resource property used to sort the SearchResults . The default is LastModifiedTime .
string
How SearchResults are ordered. Valid values are Ascending or Descending . The default is Descending .
string
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.
integer
The maximum number of results to return.
dict
Response Syntax
{ 'Results': [ { 'TrainingJob': { 'TrainingJobName': 'string', 'TrainingJobArn': 'string', 'TuningJobArn': 'string', 'LabelingJobArn': 'string', 'AutoMLJobArn': 'string', 'ModelArtifacts': { 'S3ModelArtifacts': 'string' }, 'TrainingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'SecondaryStatus': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded'|'Updating'|'Restarting', 'FailureReason': 'string', 'HyperParameters': { 'string': 'string' }, 'AlgorithmSpecification': { 'TrainingImage': 'string', 'AlgorithmName': 'string', 'TrainingInputMode': 'Pipe'|'File'|'FastFile', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ], 'EnableSageMakerMetricsTimeSeries': True|False }, 'RoleArn': 'string', 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File'|'FastFile', 'ShuffleConfig': { 'Seed': 123 } }, ], 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { 'InstanceType': '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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'CreationTime': datetime(2015, 1, 1), 'TrainingStartTime': datetime(2015, 1, 1), 'TrainingEndTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'SecondaryStatusTransitions': [ { 'Status': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded'|'Updating'|'Restarting', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'StatusMessage': 'string' }, ], 'FinalMetricDataList': [ { 'MetricName': 'string', 'Value': ..., 'Timestamp': datetime(2015, 1, 1) }, ], 'EnableNetworkIsolation': True|False, 'EnableInterContainerTrafficEncryption': True|False, 'EnableManagedSpotTraining': True|False, 'CheckpointConfig': { 'S3Uri': 'string', 'LocalPath': 'string' }, 'TrainingTimeInSeconds': 123, 'BillableTimeInSeconds': 123, 'DebugHookConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string', 'HookParameters': { 'string': 'string' }, 'CollectionConfigurations': [ { 'CollectionName': 'string', 'CollectionParameters': { 'string': 'string' } }, ] }, 'ExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' }, 'DebugRuleConfigurations': [ { 'RuleConfigurationName': 'string', 'LocalPath': 'string', 'S3OutputPath': 'string', 'RuleEvaluatorImage': 'string', 'InstanceType': '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', 'VolumeSizeInGB': 123, 'RuleParameters': { 'string': 'string' } }, ], 'TensorBoardOutputConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string' }, 'DebugRuleEvaluationStatuses': [ { 'RuleConfigurationName': 'string', 'RuleEvaluationJobArn': 'string', 'RuleEvaluationStatus': 'InProgress'|'NoIssuesFound'|'IssuesFound'|'Error'|'Stopping'|'Stopped', 'StatusDetails': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'Environment': { 'string': 'string' }, 'RetryStrategy': { 'MaximumRetryAttempts': 123 }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Experiment': { 'ExperimentName': 'string', 'ExperimentArn': 'string', 'DisplayName': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': 'string' }, 'Description': 'string', 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Trial': { 'TrialName': 'string', 'TrialArn': 'string', 'DisplayName': 'string', 'ExperimentName': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'MetadataProperties': { 'CommitId': 'string', 'Repository': 'string', 'GeneratedBy': 'string', 'ProjectId': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'TrialComponentSummaries': [ { 'TrialComponentName': 'string', 'TrialComponentArn': 'string', 'TrialComponentSource': { 'SourceArn': 'string', 'SourceType': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' } }, ] }, 'TrialComponent': { 'TrialComponentName': 'string', 'DisplayName': 'string', 'TrialComponentArn': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': 'string' }, 'Status': { 'PrimaryStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'Message': 'string' }, 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'Parameters': { 'string': { 'StringValue': 'string', 'NumberValue': 123.0 } }, 'InputArtifacts': { 'string': { 'MediaType': 'string', 'Value': 'string' } }, 'OutputArtifacts': { 'string': { 'MediaType': 'string', 'Value': 'string' } }, 'Metrics': [ { 'MetricName': 'string', 'SourceArn': 'string', 'TimeStamp': datetime(2015, 1, 1), 'Max': 123.0, 'Min': 123.0, 'Last': 123.0, 'Count': 123, 'Avg': 123.0, 'StdDev': 123.0 }, ], 'MetadataProperties': { 'CommitId': 'string', 'Repository': 'string', 'GeneratedBy': 'string', 'ProjectId': 'string' }, 'SourceDetail': { 'SourceArn': 'string', 'TrainingJob': { 'TrainingJobName': 'string', 'TrainingJobArn': 'string', 'TuningJobArn': 'string', 'LabelingJobArn': 'string', 'AutoMLJobArn': 'string', 'ModelArtifacts': { 'S3ModelArtifacts': 'string' }, 'TrainingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'SecondaryStatus': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded'|'Updating'|'Restarting', 'FailureReason': 'string', 'HyperParameters': { 'string': 'string' }, 'AlgorithmSpecification': { 'TrainingImage': 'string', 'AlgorithmName': 'string', 'TrainingInputMode': 'Pipe'|'File'|'FastFile', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ], 'EnableSageMakerMetricsTimeSeries': True|False }, 'RoleArn': 'string', 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File'|'FastFile', 'ShuffleConfig': { 'Seed': 123 } }, ], 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { 'InstanceType': '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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'CreationTime': datetime(2015, 1, 1), 'TrainingStartTime': datetime(2015, 1, 1), 'TrainingEndTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'SecondaryStatusTransitions': [ { 'Status': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded'|'Updating'|'Restarting', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'StatusMessage': 'string' }, ], 'FinalMetricDataList': [ { 'MetricName': 'string', 'Value': ..., 'Timestamp': datetime(2015, 1, 1) }, ], 'EnableNetworkIsolation': True|False, 'EnableInterContainerTrafficEncryption': True|False, 'EnableManagedSpotTraining': True|False, 'CheckpointConfig': { 'S3Uri': 'string', 'LocalPath': 'string' }, 'TrainingTimeInSeconds': 123, 'BillableTimeInSeconds': 123, 'DebugHookConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string', 'HookParameters': { 'string': 'string' }, 'CollectionConfigurations': [ { 'CollectionName': 'string', 'CollectionParameters': { 'string': 'string' } }, ] }, 'ExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' }, 'DebugRuleConfigurations': [ { 'RuleConfigurationName': 'string', 'LocalPath': 'string', 'S3OutputPath': 'string', 'RuleEvaluatorImage': 'string', 'InstanceType': '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', 'VolumeSizeInGB': 123, 'RuleParameters': { 'string': 'string' } }, ], 'TensorBoardOutputConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string' }, 'DebugRuleEvaluationStatuses': [ { 'RuleConfigurationName': 'string', 'RuleEvaluationJobArn': 'string', 'RuleEvaluationStatus': 'InProgress'|'NoIssuesFound'|'IssuesFound'|'Error'|'Stopping'|'Stopped', 'StatusDetails': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'Environment': { 'string': 'string' }, 'RetryStrategy': { 'MaximumRetryAttempts': 123 }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'ProcessingJob': { 'ProcessingInputs': [ { 'InputName': 'string', 'AppManaged': True|False, 'S3Input': { 'S3Uri': 'string', 'LocalPath': 'string', 'S3DataType': 'ManifestFile'|'S3Prefix', 'S3InputMode': 'Pipe'|'File', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'S3CompressionType': 'None'|'Gzip' }, 'DatasetDefinition': { 'AthenaDatasetDefinition': { 'Catalog': 'string', 'Database': 'string', 'QueryString': 'string', 'WorkGroup': 'string', 'OutputS3Uri': 'string', 'KmsKeyId': 'string', 'OutputFormat': 'PARQUET'|'ORC'|'AVRO'|'JSON'|'TEXTFILE', 'OutputCompression': 'GZIP'|'SNAPPY'|'ZLIB' }, 'RedshiftDatasetDefinition': { 'ClusterId': 'string', 'Database': 'string', 'DbUser': 'string', 'QueryString': 'string', 'ClusterRoleArn': 'string', 'OutputS3Uri': 'string', 'KmsKeyId': 'string', 'OutputFormat': 'PARQUET'|'CSV', 'OutputCompression': 'None'|'GZIP'|'BZIP2'|'ZSTD'|'SNAPPY' }, 'LocalPath': 'string', 'DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'InputMode': 'Pipe'|'File' } }, ], 'ProcessingOutputConfig': { 'Outputs': [ { 'OutputName': 'string', 'S3Output': { 'S3Uri': 'string', 'LocalPath': 'string', 'S3UploadMode': 'Continuous'|'EndOfJob' }, 'FeatureStoreOutput': { 'FeatureGroupName': 'string' }, 'AppManaged': True|False }, ], 'KmsKeyId': 'string' }, 'ProcessingJobName': 'string', 'ProcessingResources': { 'ClusterConfig': { 'InstanceCount': 123, 'InstanceType': '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', 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' } }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123 }, 'AppSpecification': { 'ImageUri': 'string', 'ContainerEntrypoint': [ 'string', ], 'ContainerArguments': [ 'string', ] }, 'Environment': { 'string': 'string' }, 'NetworkConfig': { 'EnableInterContainerTrafficEncryption': True|False, 'EnableNetworkIsolation': True|False, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] } }, 'RoleArn': 'string', 'ExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' }, 'ProcessingJobArn': 'string', 'ProcessingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'ExitMessage': 'string', 'FailureReason': 'string', 'ProcessingEndTime': datetime(2015, 1, 1), 'ProcessingStartTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'MonitoringScheduleArn': 'string', 'AutoMLJobArn': 'string', 'TrainingJobArn': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'TransformJob': { 'TransformJobName': 'string', 'TransformJobArn': 'string', 'TransformJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'FailureReason': 'string', 'ModelName': 'string', 'MaxConcurrentTransforms': 123, 'ModelClientConfig': { 'InvocationsTimeoutInSeconds': 123, 'InvocationsMaxRetries': 123 }, 'MaxPayloadInMB': 123, 'BatchStrategy': 'MultiRecord'|'SingleRecord', 'Environment': { 'string': 'string' }, 'TransformInput': { 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'SplitType': 'None'|'Line'|'RecordIO'|'TFRecord' }, 'TransformOutput': { 'S3OutputPath': 'string', 'Accept': 'string', 'AssembleWith': 'None'|'Line', 'KmsKeyId': 'string' }, 'TransformResources': { 'InstanceType': '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', 'InstanceCount': 123, 'VolumeKmsKeyId': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'TransformStartTime': datetime(2015, 1, 1), 'TransformEndTime': datetime(2015, 1, 1), 'LabelingJobArn': 'string', 'AutoMLJobArn': 'string', 'DataProcessing': { 'InputFilter': 'string', 'OutputFilter': 'string', 'JoinSource': 'Input'|'None' }, 'ExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Parents': [ { 'TrialName': 'string', 'ExperimentName': 'string' }, ] }, 'Endpoint': { 'EndpointName': 'string', 'EndpointArn': 'string', 'EndpointConfigName': 'string', 'ProductionVariants': [ { 'VariantName': 'string', 'DeployedImages': [ { 'SpecifiedImage': 'string', 'ResolvedImage': 'string', 'ResolutionTime': datetime(2015, 1, 1) }, ], 'CurrentWeight': ..., 'DesiredWeight': ..., 'CurrentInstanceCount': 123, 'DesiredInstanceCount': 123, 'VariantStatus': [ { 'Status': 'Creating'|'Updating'|'Deleting'|'ActivatingTraffic'|'Baking', 'StatusMessage': 'string', 'StartTime': datetime(2015, 1, 1) }, ] }, ], 'DataCaptureConfig': { 'EnableCapture': True|False, 'CaptureStatus': 'Started'|'Stopped', 'CurrentSamplingPercentage': 123, 'DestinationS3Uri': 'string', 'KmsKeyId': 'string' }, 'EndpointStatus': 'OutOfService'|'Creating'|'Updating'|'SystemUpdating'|'RollingBack'|'InService'|'Deleting'|'Failed', 'FailureReason': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'MonitoringSchedules': [ { 'MonitoringScheduleArn': 'string', 'MonitoringScheduleName': 'string', 'MonitoringScheduleStatus': 'Pending'|'Failed'|'Scheduled'|'Stopped', 'MonitoringType': 'DataQuality'|'ModelQuality'|'ModelBias'|'ModelExplainability', 'FailureReason': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'MonitoringScheduleConfig': { 'ScheduleConfig': { 'ScheduleExpression': 'string' }, 'MonitoringJobDefinition': { 'BaselineConfig': { 'BaseliningJobName': 'string', 'ConstraintsResource': { 'S3Uri': 'string' }, 'StatisticsResource': { 'S3Uri': 'string' } }, 'MonitoringInputs': [ { 'EndpointInput': { 'EndpointName': 'string', 'LocalPath': 'string', 'S3InputMode': 'Pipe'|'File', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'FeaturesAttribute': 'string', 'InferenceAttribute': 'string', 'ProbabilityAttribute': 'string', 'ProbabilityThresholdAttribute': 123.0, 'StartTimeOffset': 'string', 'EndTimeOffset': 'string' } }, ], 'MonitoringOutputConfig': { 'MonitoringOutputs': [ { 'S3Output': { 'S3Uri': 'string', 'LocalPath': 'string', 'S3UploadMode': 'Continuous'|'EndOfJob' } }, ], 'KmsKeyId': 'string' }, 'MonitoringResources': { 'ClusterConfig': { 'InstanceCount': 123, 'InstanceType': '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', 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' } }, 'MonitoringAppSpecification': { 'ImageUri': 'string', 'ContainerEntrypoint': [ 'string', ], 'ContainerArguments': [ 'string', ], 'RecordPreprocessorSourceUri': 'string', 'PostAnalyticsProcessorSourceUri': 'string' }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123 }, 'Environment': { 'string': 'string' }, 'NetworkConfig': { 'EnableInterContainerTrafficEncryption': True|False, 'EnableNetworkIsolation': True|False, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] } }, 'RoleArn': 'string' }, 'MonitoringJobDefinitionName': 'string', 'MonitoringType': 'DataQuality'|'ModelQuality'|'ModelBias'|'ModelExplainability' }, 'EndpointName': 'string', 'LastMonitoringExecutionSummary': { 'MonitoringScheduleName': 'string', 'ScheduledTime': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'MonitoringExecutionStatus': 'Pending'|'Completed'|'CompletedWithViolations'|'InProgress'|'Failed'|'Stopping'|'Stopped', 'ProcessingJobArn': 'string', 'EndpointName': 'string', 'FailureReason': 'string', 'MonitoringJobDefinitionName': 'string', 'MonitoringType': 'DataQuality'|'ModelQuality'|'ModelBias'|'ModelExplainability' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'ModelPackage': { 'ModelPackageName': 'string', 'ModelPackageGroupName': 'string', 'ModelPackageVersion': 123, 'ModelPackageArn': 'string', 'ModelPackageDescription': 'string', 'CreationTime': datetime(2015, 1, 1), 'InferenceSpecification': { 'Containers': [ { 'ContainerHostname': 'string', 'Image': 'string', 'ImageDigest': 'string', 'ModelDataUrl': 'string', 'ProductId': 'string', 'Environment': { 'string': 'string' } }, ], 'SupportedTransformInstanceTypes': [ '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', ], 'SupportedRealtimeInferenceInstanceTypes': [ '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', ], 'SupportedContentTypes': [ 'string', ], 'SupportedResponseMIMETypes': [ 'string', ] }, 'SourceAlgorithmSpecification': { 'SourceAlgorithms': [ { 'ModelDataUrl': 'string', 'AlgorithmName': 'string' }, ] }, 'ValidationSpecification': { 'ValidationRole': 'string', 'ValidationProfiles': [ { 'ProfileName': 'string', 'TransformJobDefinition': { 'MaxConcurrentTransforms': 123, 'MaxPayloadInMB': 123, 'BatchStrategy': 'MultiRecord'|'SingleRecord', 'Environment': { 'string': 'string' }, 'TransformInput': { 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'SplitType': 'None'|'Line'|'RecordIO'|'TFRecord' }, 'TransformOutput': { 'S3OutputPath': 'string', 'Accept': 'string', 'AssembleWith': 'None'|'Line', 'KmsKeyId': 'string' }, 'TransformResources': { 'InstanceType': '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', 'InstanceCount': 123, 'VolumeKmsKeyId': 'string' } } }, ] }, 'ModelPackageStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting', 'ModelPackageStatusDetails': { 'ValidationStatuses': [ { 'Name': 'string', 'Status': 'NotStarted'|'InProgress'|'Completed'|'Failed', 'FailureReason': 'string' }, ], 'ImageScanStatuses': [ { 'Name': 'string', 'Status': 'NotStarted'|'InProgress'|'Completed'|'Failed', 'FailureReason': 'string' }, ] }, 'CertifyForMarketplace': True|False, 'ModelApprovalStatus': 'Approved'|'Rejected'|'PendingManualApproval', 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'MetadataProperties': { 'CommitId': 'string', 'Repository': 'string', 'GeneratedBy': 'string', 'ProjectId': 'string' }, 'ModelMetrics': { 'ModelQuality': { 'Statistics': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'Constraints': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } }, 'ModelDataQuality': { 'Statistics': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'Constraints': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } }, 'Bias': { 'Report': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } }, 'Explainability': { 'Report': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'ApprovalDescription': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'CustomerMetadataProperties': { 'string': 'string' } }, 'ModelPackageGroup': { 'ModelPackageGroupName': 'string', 'ModelPackageGroupArn': 'string', 'ModelPackageGroupDescription': 'string', 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'ModelPackageGroupStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting'|'DeleteFailed', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Pipeline': { 'PipelineArn': 'string', 'PipelineName': 'string', 'PipelineDisplayName': 'string', 'PipelineDescription': 'string', 'RoleArn': 'string', 'PipelineStatus': 'Active', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'LastRunTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'PipelineExecution': { 'PipelineArn': 'string', 'PipelineExecutionArn': 'string', 'PipelineExecutionDisplayName': 'string', 'PipelineExecutionStatus': 'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded', 'PipelineExecutionDescription': 'string', 'PipelineExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string' }, 'FailureReason': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'PipelineParameters': [ { 'Name': 'string', 'Value': 'string' }, ] }, 'FeatureGroup': { 'FeatureGroupArn': 'string', 'FeatureGroupName': 'string', 'RecordIdentifierFeatureName': 'string', 'EventTimeFeatureName': 'string', 'FeatureDefinitions': [ { 'FeatureName': 'string', 'FeatureType': 'Integral'|'Fractional'|'String' }, ], 'CreationTime': datetime(2015, 1, 1), 'OnlineStoreConfig': { 'SecurityConfig': { 'KmsKeyId': 'string' }, 'EnableOnlineStore': True|False }, 'OfflineStoreConfig': { 'S3StorageConfig': { 'S3Uri': 'string', 'KmsKeyId': 'string', 'ResolvedOutputS3Uri': 'string' }, 'DisableGlueTableCreation': True|False, 'DataCatalogConfig': { 'TableName': 'string', 'Catalog': 'string', 'Database': 'string' } }, 'RoleArn': 'string', 'FeatureGroupStatus': 'Creating'|'Created'|'CreateFailed'|'Deleting'|'DeleteFailed', 'OfflineStoreStatus': { 'Status': 'Active'|'Blocked'|'Disabled', 'BlockedReason': 'string' }, 'FailureReason': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Project': { 'ProjectArn': 'string', 'ProjectName': 'string', 'ProjectId': 'string', 'ProjectDescription': 'string', 'ServiceCatalogProvisioningDetails': { 'ProductId': 'string', 'ProvisioningArtifactId': 'string', 'PathId': 'string', 'ProvisioningParameters': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'ServiceCatalogProvisionedProductDetails': { 'ProvisionedProductId': 'string', 'ProvisionedProductStatusMessage': 'string' }, 'ProjectStatus': 'Pending'|'CreateInProgress'|'CreateCompleted'|'CreateFailed'|'DeleteInProgress'|'DeleteFailed'|'DeleteCompleted'|'UpdateInProgress'|'UpdateCompleted'|'UpdateFailed', 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' } } }, ], 'NextToken': 'string' } **Response Structure** :: # This section is too large to render. # Please see the AWS API Documentation linked below. `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/Search>`_
{'DeploymentConfig': {'BlueGreenUpdatePolicy': {'TrafficRoutingConfiguration': {'LinearStepSize': {'Type': 'INSTANCE_COUNT ' '| ' 'CAPACITY_PERCENT', 'Value': 'integer'}, 'Type': {'LINEAR'}}}}, 'RetainDeploymentConfig': 'boolean'}
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 Amazon 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.
Note
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.
See also: AWS API Documentation
Request Syntax
client.update_endpoint( EndpointName='string', EndpointConfigName='string', RetainAllVariantProperties=True|False, ExcludeRetainedVariantProperties=[ { 'VariantPropertyType': 'DesiredInstanceCount'|'DesiredWeight'|'DataCaptureConfig' }, ], DeploymentConfig={ 'BlueGreenUpdatePolicy': { 'TrafficRoutingConfiguration': { 'Type': 'ALL_AT_ONCE'|'CANARY'|'LINEAR', 'WaitIntervalInSeconds': 123, 'CanarySize': { 'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENT', 'Value': 123 }, 'LinearStepSize': { 'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENT', 'Value': 123 } }, 'TerminationWaitInSeconds': 123, 'MaximumExecutionTimeoutInSeconds': 123 }, 'AutoRollbackConfiguration': { 'Alarms': [ { 'AlarmName': 'string' }, ] } }, RetainDeploymentConfig=True|False )
string
[REQUIRED]
The name of the endpoint whose configuration you want to update.
string
[REQUIRED]
The name of the new endpoint configuration.
boolean
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 .
list
When you are updating endpoint resources with UpdateEndpointInput$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 ExcludeAllVariantProperties , no variant properties are overridden.
(dict) --
Specifies a production variant property type for an Endpoint.
If you are updating an endpoint with the UpdateEndpointInput$RetainAllVariantProperties option set to true , the VariantProperty objects listed in UpdateEndpointInput$ExcludeRetainedVariantProperties override the existing variant properties of the endpoint.
VariantPropertyType (string) -- [REQUIRED]
The type of variant property. The supported values are:
DesiredInstanceCount : Overrides the existing variant instance counts using the ProductionVariant$InitialInstanceCount values in the CreateEndpointConfigInput$ProductionVariants.
DesiredWeight : Overrides the existing variant weights using the ProductionVariant$InitialVariantWeight values in the CreateEndpointConfigInput$ProductionVariants.
DataCaptureConfig : (Not currently supported.)
dict
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
BlueGreenUpdatePolicy (dict) -- [REQUIRED]
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.
TrafficRoutingConfiguration (dict) -- [REQUIRED]
Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.
Type (string) -- [REQUIRED]
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.
WaitIntervalInSeconds (integer) -- [REQUIRED]
The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
CanarySize (dict) --
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.
Type (string) -- [REQUIRED]
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.
Value (integer) -- [REQUIRED]
Defines the capacity size, either as a number of instances or a capacity percentage.
LinearStepSize (dict) --
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.
Type (string) -- [REQUIRED]
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.
Value (integer) -- [REQUIRED]
Defines the capacity size, either as a number of instances or a capacity percentage.
TerminationWaitInSeconds (integer) --
Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.
MaximumExecutionTimeoutInSeconds (integer) --
Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds .
AutoRollbackConfiguration (dict) --
Automatic rollback configuration for handling endpoint deployment failures and recovery.
Alarms (list) --
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.
(dict) --
An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
AlarmName (string) --
The name of a CloudWatch alarm in your account.
boolean
Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
dict
Response Syntax
{ 'EndpointArn': 'string' }
Response Structure
(dict) --
EndpointArn (string) --
The Amazon Resource Name (ARN) of the endpoint.