com.amazonaws.services.marketplaceagreement.AWSMarketplaceAgreement Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019-2024 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.marketplaceagreement;

import javax.annotation.Generated;

import com.amazonaws.*;
import com.amazonaws.regions.*;

import com.amazonaws.services.marketplaceagreement.model.*;

/**
 * Interface for accessing Agreement Service.
 * 
 * Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
 * {@link com.amazonaws.services.marketplaceagreement.AbstractAWSMarketplaceAgreement} instead.
 * 
 * 
 * 

 * AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party
 * software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service
 * provides an API interface that helps AWS Marketplace sellers manage their product-related agreements, including
 * listing, searching, and filtering agreements.
 * 
 * 
 * To manage agreements in AWS Marketplace, you must ensure that your AWS Identity and Access Management (IAM) policies
 * and roles are set up. The user must have the required policies/permissions that allow them to carry out the actions
 * in AWS:
 * 
 * 
 * 
 * 
 * DescribeAgreement – Grants permission to users to obtain detailed meta data about any of their
 * agreements.
 * 
 * 
 * 
 * 
 * GetAgreementTerms – Grants permission to users to obtain details about the terms of an agreement.
 * 
 * 
 * 
 * 
 * SearchAgreements – Grants permission to users to search through all their agreements.
 * 
 * 
 * 
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMarketplaceAgreement {

    /**
     * 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 RegionUtils#getRegionsForService(String)
     */
    String ENDPOINT_PREFIX = "agreement-marketplace";

    /**
     * 
     * Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
     * 
     * 
     * @param describeAgreementRequest
     * @return Result of the DescribeAgreement operation returned by the service.
     * @throws ValidationException
     *         The input fails to satisfy the constraints specified by the service.
     * @throws AccessDeniedException
     *         User does not have sufficient access to perform this action.
     * @throws ThrottlingException
     *         Request was denied due to request throttling.
     * @throws ResourceNotFoundException
     *         Request references a resource which does not exist.
     * @throws InternalServerException
     *         Unexpected error during processing of request.
     * @sample AWSMarketplaceAgreement.DescribeAgreement
     * @see AWS API Documentation
     */
    DescribeAgreementResult describeAgreement(DescribeAgreementRequest describeAgreementRequest);

    /**
     * 
     * Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
     * 
     * 
     * The details include:
     * 
     * 
     * 
     * 
     * TermType – The type of term, such as LegalTerm, RenewalTerm, or
     * ConfigurableUpfrontPricingTerm.
     * 
     * 
     * 
     * 
     * TermID – The ID of the particular term, which is common between offer and agreement.
     * 
     * 
     * 
     * 
     * TermPayload – The key information contained in the term, such as the EULA for LegalTerm
     * or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or
     * UsageBasedPricingTerm.
     * 
     * 
     * 
     * 
     * 
     * 
     * Configuration – The buyer/acceptor's selection at the time of agreement creation, such as the number
     * of units purchased for a dimension or setting the EnableAutoRenew flag.
     * 
     * 
     * 
     * 
     * @param getAgreementTermsRequest
     * @return Result of the GetAgreementTerms operation returned by the service.
     * @throws ValidationException
     *         The input fails to satisfy the constraints specified by the service.
     * @throws AccessDeniedException
     *         User does not have sufficient access to perform this action.
     * @throws ThrottlingException
     *         Request was denied due to request throttling.
     * @throws ResourceNotFoundException
     *         Request references a resource which does not exist.
     * @throws InternalServerException
     *         Unexpected error during processing of request.
     * @sample AWSMarketplaceAgreement.GetAgreementTerms
     * @see AWS API Documentation
     */
    GetAgreementTermsResult getAgreementTerms(GetAgreementTermsRequest getAgreementTermsRequest);

    /**
     * 
     * Searches across all agreements that a proposer or an acceptor has in AWS Marketplace. The search returns a list
     * of agreements with basic agreement information.
     * 
     * 
     * The following filter combinations are supported:
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + ResourceIdentifier
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + OfferId
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + AcceptorAccountId
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + Status
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + ResourceIdentifier +
     * Status
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + OfferId +
     * Status
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + AcceptorAccountId +
     * Status
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + ResourceType +
     * Status
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + AcceptorAccountId +
     * ResourceType + Status
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + AcceptorAccountId +
     * OfferId
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + AcceptorAccountId +
     * OfferId + Status
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + AcceptorAccountId +
     * ResourceIdentifier
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + AcceptorAccountId +
     * ResourceIdentifier + Status
     * 
     * 
     * 
     * 
     * PartyType as Proposer + AgreementType + AcceptorAccountId +
     * ResourceType
     * 
     * 
     * 
     * 
     * @param searchAgreementsRequest
     * @return Result of the SearchAgreements operation returned by the service.
     * @throws ValidationException
     *         The input fails to satisfy the constraints specified by the service.
     * @throws AccessDeniedException
     *         User does not have sufficient access to perform this action.
     * @throws ThrottlingException
     *         Request was denied due to request throttling.
     * @throws InternalServerException
     *         Unexpected error during processing of request.
     * @sample AWSMarketplaceAgreement.SearchAgreements
     * @see AWS API Documentation
     */
    SearchAgreementsResult searchAgreements(SearchAgreementsRequest searchAgreementsRequest);

    /**
     * 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.
     */
    void shutdown();

    /**
     * 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.
     *
     * @param request
     *        The originally executed request.
     *
     * @return The response metadata for the specified request, or null if none is available.
     */
    ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);

}