com.amazon.paapi

Interface ProductAdvertisingAPI

All Known Subinterfaces:

ProductAdvertisingAPIAsync

All Known Implementing Classes:

AbstractProductAdvertisingAPI, AbstractProductAdvertisingAPIAsync, ProductAdvertisingAPIAsyncClient, ProductAdvertisingAPIClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface ProductAdvertisingAPI

Interface for accessing ProductAdvertisingAPI.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractProductAdvertisingAPI instead.

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
static java.lang.String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
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 getRecommendationsRequest) GetRecommendations operation allows associates to retrieve a set of product recommendations from Amazon catalog complementary to the input content in JSON format.
void	setEndpoint(java.lang.String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final java.lang.String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils#getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(java.lang.String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("https://webservices.amazon.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "webservices.amazon.com/") or a full URL, including the protocol (ex: "https://webservices.amazon.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "webservices.amazon.com/") or a full URL, including the protocol (ex: "https://webservices.amazon.com/") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region#getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region#getRegion(com.amazonaws.regions.Regions), Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region#isServiceSupported(String)

getRecommendations

GetRecommendationsResult getRecommendations(GetRecommendationsRequest getRecommendationsRequest)

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

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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