/* * 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.personalizeruntime; 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.personalizeruntime.AmazonPersonalizeRuntimeClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.personalizeruntime.model.*; import com.amazonaws.services.personalizeruntime.model.transform.*; /** * Client for accessing Amazon Personalize Runtime. All service calls made using this client are blocking, and will not * return until the service call completes. *
*
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AmazonPersonalizeRuntimeClient extends AmazonWebServiceClient implements AmazonPersonalizeRuntime { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AmazonPersonalizeRuntime.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "personalize"; /** 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("InvalidInputException").withExceptionUnmarshaller( com.amazonaws.services.personalizeruntime.model.transform.InvalidInputExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.personalizeruntime.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.personalizeruntime.model.AmazonPersonalizeRuntimeException.class)); public static AmazonPersonalizeRuntimeClientBuilder builder() { return AmazonPersonalizeRuntimeClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on Amazon Personalize 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. */ AmazonPersonalizeRuntimeClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on Amazon Personalize 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. */ AmazonPersonalizeRuntimeClient(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("personalize-runtime.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/personalizeruntime/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/personalizeruntime/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely * item to be of interest to the user. *
** The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING. *
** Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the * required user and item input depends on the recipe type used to create the solution backing the campaign as * follows: *
*
* USER_PERSONALIZATION - userId
required, itemId
not used
*
* RELATED_ITEMS - itemId
required, userId
not used
*
* Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API. *
** For recommenders, the recommender's ARN is required and the required item and user input depends on the use case * (domain-based recipe) backing the recommender. For information on use case requirements see Choosing recommender use * cases. *
* * @param getRecommendationsRequest * @return Result of the GetRecommendations operation returned by the service. * @throws InvalidInputException * Provide a valid value for the field or parameter. * @throws ResourceNotFoundException * The specified resource does not exist. * @sample AmazonPersonalizeRuntime.GetRecommendations * @see AWS API Documentation */ @Override public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request) { request = beforeClientExecution(request); return executeGetRecommendations(request); } @SdkInternalApi final GetRecommendationsResult executeGetRecommendations(GetRecommendationsRequest getRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(getRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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