/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemakerruntime; import org.w3c.dom.*; import java.net.*; import java.util.*; import javax.annotation.Generated; import org.apache.commons.logging.*; import com.amazonaws.*; import com.amazonaws.annotation.SdkInternalApi; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.internal.auth.*; import com.amazonaws.metrics.*; import com.amazonaws.regions.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.protocol.json.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.annotation.ThreadSafe; import com.amazonaws.client.AwsSyncClientParams; import com.amazonaws.client.builder.AdvancedConfig; import com.amazonaws.services.sagemakerruntime.AmazonSageMakerRuntimeClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.sagemakerruntime.model.*; import com.amazonaws.services.sagemakerruntime.model.transform.*; /** * Client for accessing Amazon SageMaker Runtime. All service calls made using this client are blocking, and will not * return until the service call completes. *

*

* The Amazon SageMaker runtime API. *

*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AmazonSageMakerRuntimeClient extends AmazonWebServiceClient implements AmazonSageMakerRuntime { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AmazonSageMakerRuntime.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "sagemaker"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalFailure").withExceptionUnmarshaller( com.amazonaws.services.sagemakerruntime.model.transform.InternalFailureExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ModelError").withExceptionUnmarshaller( com.amazonaws.services.sagemakerruntime.model.transform.ModelErrorExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalDependencyException").withExceptionUnmarshaller( com.amazonaws.services.sagemakerruntime.model.transform.InternalDependencyExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationError").withExceptionUnmarshaller( com.amazonaws.services.sagemakerruntime.model.transform.ValidationErrorExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ModelNotReadyException").withExceptionUnmarshaller( com.amazonaws.services.sagemakerruntime.model.transform.ModelNotReadyExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ServiceUnavailable").withExceptionUnmarshaller( com.amazonaws.services.sagemakerruntime.model.transform.ServiceUnavailableExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.sagemakerruntime.model.AmazonSageMakerRuntimeException.class)); public static AmazonSageMakerRuntimeClientBuilder builder() { return AmazonSageMakerRuntimeClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on Amazon SageMaker Runtime using the specified parameters. * *

* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonSageMakerRuntimeClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on Amazon SageMaker Runtime using the specified parameters. * *

* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonSageMakerRuntimeClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("runtime.sagemaker.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/sagemakerruntime/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/sagemakerruntime/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *

* After you deploy a model into production using Amazon SageMaker hosting services, your client applications use * this API to get inferences from the model hosted at the specified endpoint. *

*

* For an overview of Amazon SageMaker, see How It Works. *

*

* Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional * headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. *

*

* Calls to InvokeEndpoint are authenticated by using Amazon Web Services Signature Version 4. For * information, see Authenticating * Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference. *

*

* A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum * processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of * processing time, the SDK socket timeout should be set to be 70 seconds. *

* *

* Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but * Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller. *

* * * @param invokeEndpointRequest * @return Result of the InvokeEndpoint operation returned by the service. * @throws InternalFailureException * An internal failure occurred. * @throws ServiceUnavailableException * The service is unavailable. Try your call again. * @throws ValidationErrorException * Inspect your request and try again. * @throws ModelErrorException * Model (owned by the customer in the container) returned 4xx or 5xx error code. * @throws InternalDependencyException * Your request caused an exception with an internal dependency. Contact customer support. * @throws ModelNotReadyException * Either a serverless endpoint variant's resources are still being provisioned, or a multi-model endpoint * is still downloading or loading the target model. Wait and try your request again. * @sample AmazonSageMakerRuntime.InvokeEndpoint * @see AWS API Documentation */ @Override public InvokeEndpointResult invokeEndpoint(InvokeEndpointRequest request) { request = beforeClientExecution(request); return executeInvokeEndpoint(request); } @SdkInternalApi final InvokeEndpointResult executeInvokeEndpoint(InvokeEndpointRequest invokeEndpointRequest) { ExecutionContext executionContext = createExecutionContext(invokeEndpointRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new InvokeEndpointRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(invokeEndpointRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "SageMaker Runtime"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "InvokeEndpoint"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(false).withHasStreamingSuccessResponse(false), new InvokeEndpointResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* After you deploy a model into production using Amazon SageMaker hosting services, your client applications use * this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner. *

*

* Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference * request may or may not complete before you receive a response from this API. The response from this API will not * contain the result of the inference request but contain information about where you can locate it. *

*

* Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might * add additional headers. You should not rely on the behavior of headers outside those enumerated in the request * syntax. *

*

* Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For * information, see Authenticating * Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference. *

* * @param invokeEndpointAsyncRequest * @return Result of the InvokeEndpointAsync operation returned by the service. * @throws InternalFailureException * An internal failure occurred. * @throws ServiceUnavailableException * The service is unavailable. Try your call again. * @throws ValidationErrorException * Inspect your request and try again. * @sample AmazonSageMakerRuntime.InvokeEndpointAsync * @see AWS API Documentation */ @Override public InvokeEndpointAsyncResult invokeEndpointAsync(InvokeEndpointAsyncRequest request) { request = beforeClientExecution(request); return executeInvokeEndpointAsync(request); } @SdkInternalApi final InvokeEndpointAsyncResult executeInvokeEndpointAsync(InvokeEndpointAsyncRequest invokeEndpointAsyncRequest) { ExecutionContext executionContext = createExecutionContext(invokeEndpointAsyncRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new InvokeEndpointAsyncRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(invokeEndpointAsyncRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "SageMaker Runtime"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "InvokeEndpointAsync"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new InvokeEndpointAsyncResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * Returns additional metadata for a previously executed successful, request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing the request. * * @param request * The originally executed request * * @return The response metadata for the specified request, or null if none is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) { return client.getResponseMetadataForRequest(request); } /** * Normal invoke with authentication. Credentials are required and may be overriden at the request level. **/ private Response invoke(Request request, HttpResponseHandler> responseHandler, ExecutionContext executionContext) { return invoke(request, responseHandler, executionContext, null, null); } /** * Normal invoke with authentication. Credentials are required and may be overriden at the request level. **/ private Response invoke(Request request, HttpResponseHandler> responseHandler, ExecutionContext executionContext, URI cachedEndpoint, URI uriFromEndpointTrait) { executionContext.setCredentialsProvider(CredentialUtils.getCredentialsProvider(request.getOriginalRequest(), awsCredentialsProvider)); return doInvoke(request, responseHandler, executionContext, cachedEndpoint, uriFromEndpointTrait); } /** * Invoke with no authentication. Credentials are not required and any credentials set on the client or request will * be ignored for this operation. **/ private Response anonymousInvoke(Request request, HttpResponseHandler> responseHandler, ExecutionContext executionContext) { return doInvoke(request, responseHandler, executionContext, null, null); } /** * Invoke the request using the http client. Assumes credentials (or lack thereof) have been configured in the * ExecutionContext beforehand. **/ private Response doInvoke(Request request, HttpResponseHandler> responseHandler, ExecutionContext executionContext, URI discoveredEndpoint, URI uriFromEndpointTrait) { if (discoveredEndpoint != null) { request.setEndpoint(discoveredEndpoint); request.getOriginalRequest().getRequestClientOptions().appendUserAgent("endpoint-discovery"); } else if (uriFromEndpointTrait != null) { request.setEndpoint(uriFromEndpointTrait); } else { request.setEndpoint(endpoint); } request.setTimeOffset(timeOffset); HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler(new JsonErrorResponseMetadata()); return client.execute(request, responseHandler, errorResponseHandler, executionContext); } @com.amazonaws.annotation.SdkInternalApi static com.amazonaws.protocol.json.SdkJsonProtocolFactory getProtocolFactory() { return protocolFactory; } @Override public void shutdown() { super.shutdown(); } }