com.amazon.paapi

Class ProductAdvertisingAPIClient

java.lang.Object

AmazonWebServiceClient

com.amazon.paapi.ProductAdvertisingAPIClient

All Implemented Interfaces:

ProductAdvertisingAPI

Direct Known Subclasses:

ProductAdvertisingAPIAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProductAdvertisingAPIClient
extends AmazonWebServiceClient
implements ProductAdvertisingAPI

Client for accessing ProductAdvertisingAPI. All service calls made using this client are blocking, and will not return until the service call completes.

The Product Advertising API provides programmatic access to Amazon’s product selection and discovery functionality so that developers like you can advertise Amazon products to monetize your website. The Product Advertising API helps you advertise Amazon products using product search and look up capability, product information and features such as Customer Reviews, Similar Products, Wish Lists and New and Used listings.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from interface com.amazon.paapi.ProductAdvertisingAPI

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
ProductAdvertisingAPIClient() Deprecated. use ProductAdvertisingAPIClientBuilder.defaultClient()
ProductAdvertisingAPIClient(AWSCredentials awsCredentials) Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider) for example: ProductAdvertisingAPIClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
ProductAdvertisingAPIClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIClientBuilder#withClientConfiguration(ClientConfiguration)
ProductAdvertisingAPIClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider)
ProductAdvertisingAPIClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIClientBuilder#withClientConfiguration(ClientConfiguration)
ProductAdvertisingAPIClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIClientBuilder#withClientConfiguration(ClientConfiguration) and ProductAdvertisingAPIClientBuilder#withMetricsCollector(RequestMetricCollector)
ProductAdvertisingAPIClient(ClientConfiguration clientConfiguration) Deprecated. use ProductAdvertisingAPIClientBuilder#withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static ProductAdvertisingAPIClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetRecommendationsResult	getRecommendations(GetRecommendationsRequest request) GetRecommendations operation allows associates to retrieve a set of product recommendations from Amazon catalog complementary to the input content in JSON format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazon.paapi.ProductAdvertisingAPI

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

ProductAdvertisingAPIClient

@Deprecated
public ProductAdvertisingAPIClient()

Deprecated. use ProductAdvertisingAPIClientBuilder.defaultClient()

Constructs a new client to invoke service methods on ProductAdvertisingAPI. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

ProductAdvertisingAPIClient

@Deprecated
public ProductAdvertisingAPIClient(ClientConfiguration clientConfiguration)

Deprecated. use ProductAdvertisingAPIClientBuilder#withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on ProductAdvertisingAPI. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to ProductAdvertisingAPI (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

ProductAdvertisingAPIClient

@Deprecated
public ProductAdvertisingAPIClient(AWSCredentials awsCredentials)

Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider) for example: ProductAdvertisingAPIClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

ProductAdvertisingAPIClient

@Deprecated
public ProductAdvertisingAPIClient(AWSCredentials awsCredentials,
                                               ClientConfiguration clientConfiguration)

Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIClientBuilder#withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to ProductAdvertisingAPI (ex: proxy settings, retry counts, etc.).

ProductAdvertisingAPIClient

@Deprecated
public ProductAdvertisingAPIClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

ProductAdvertisingAPIClient

@Deprecated
public ProductAdvertisingAPIClient(AWSCredentialsProvider awsCredentialsProvider,
                                               ClientConfiguration clientConfiguration)

Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIClientBuilder#withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to ProductAdvertisingAPI (ex: proxy settings, retry counts, etc.).

ProductAdvertisingAPIClient

@Deprecated
public ProductAdvertisingAPIClient(AWSCredentialsProvider awsCredentialsProvider,
                                               ClientConfiguration clientConfiguration,
                                               RequestMetricCollector requestMetricCollector)

Deprecated. use ProductAdvertisingAPIClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIClientBuilder#withClientConfiguration(ClientConfiguration) and ProductAdvertisingAPIClientBuilder#withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to ProductAdvertisingAPI (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static ProductAdvertisingAPIClientBuilder builder()

getRecommendations

public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request)

GetRecommendations operation allows associates to retrieve a set of product recommendations from Amazon catalog complementary to the input content in JSON format.

Specified by:

getRecommendations in interface ProductAdvertisingAPI

Parameters:

getRecommendationsRequest - It contains request parameters for the GetRecommendations operation. You can specify up to X number of parameters for each request. Specify the parameters in JSON as part of the body of the request.

Returns:

Result of the GetRecommendations operation returned by the service.

Throws:

AccessDeniedException - Model for AccessDeniedException

IncompleteSignatureException - Model for IncompleteSignatureException

InvalidSignatureException - Model for InvalidSignatureException

RequestExpiredException - Model for RequestExpiredException

TooManyRequestsException - Model for ThrottlingException

UnrecognizedClientException - Model for UnrecognizedClientException

UnknownOperationException - Model for UnknownOperationException

ValidationException - Model for ValidationException

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

Specified by:

getCachedResponseMetadata in interface ProductAdvertisingAPI

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.