DescribeAgreement

$result = $client->describeAgreement([/* ... */]);
$promise = $client->describeAgreementAsync([/* ... */]);

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

Parameter Syntax

$result = $client->describeAgreement([
    'agreementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'acceptanceTime' => <DateTime>,
    'acceptor' => [
        'accountId' => '<string>',
    ],
    'agreementId' => '<string>',
    'agreementType' => '<string>',
    'endTime' => <DateTime>,
    'estimatedCharges' => [
        'agreementValue' => '<string>',
        'currencyCode' => '<string>',
    ],
    'proposalSummary' => [
        'offerId' => '<string>',
        'resources' => [
            [
                'id' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
    ],
    'proposer' => [
        'accountId' => '<string>',
    ],
    'startTime' => <DateTime>,
    'status' => 'ACTIVE|ARCHIVED|CANCELLED|EXPIRED|RENEWED|REPLACED|ROLLED_BACK|SUPERSEDED|TERMINATED',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

GetAgreementTerms

$result = $client->getAgreementTerms([/* ... */]);
$promise = $client->getAgreementTermsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAgreementTerms([
    'agreementId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'acceptedTerms' => [
        [
            'byolPricingTerm' => [
                'type' => '<string>',
            ],
            'configurableUpfrontPricingTerm' => [
                'configuration' => [
                    'dimensions' => [
                        [
                            'dimensionKey' => '<string>',
                            'dimensionValue' => <integer>,
                        ],
                        // ...
                    ],
                    'selectorValue' => '<string>',
                ],
                'currencyCode' => '<string>',
                'rateCards' => [
                    [
                        'constraints' => [
                            'multipleDimensionSelection' => '<string>',
                            'quantityConfiguration' => '<string>',
                        ],
                        'rateCard' => [
                            [
                                'dimensionKey' => '<string>',
                                'price' => '<string>',
                            ],
                            // ...
                        ],
                        'selector' => [
                            'type' => '<string>',
                            'value' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'fixedUpfrontPricingTerm' => [
                'currencyCode' => '<string>',
                'duration' => '<string>',
                'grants' => [
                    [
                        'dimensionKey' => '<string>',
                        'maxQuantity' => <integer>,
                    ],
                    // ...
                ],
                'price' => '<string>',
                'type' => '<string>',
            ],
            'freeTrialPricingTerm' => [
                'duration' => '<string>',
                'grants' => [
                    [
                        'dimensionKey' => '<string>',
                        'maxQuantity' => <integer>,
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'legalTerm' => [
                'documents' => [
                    [
                        'type' => '<string>',
                        'url' => '<string>',
                        'version' => '<string>',
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'paymentScheduleTerm' => [
                'currencyCode' => '<string>',
                'schedule' => [
                    [
                        'chargeAmount' => '<string>',
                        'chargeDate' => <DateTime>,
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'recurringPaymentTerm' => [
                'billingPeriod' => '<string>',
                'currencyCode' => '<string>',
                'price' => '<string>',
                'type' => '<string>',
            ],
            'renewalTerm' => [
                'configuration' => [
                    'enableAutoRenew' => true || false,
                ],
                'type' => '<string>',
            ],
            'supportTerm' => [
                'refundPolicy' => '<string>',
                'type' => '<string>',
            ],
            'usageBasedPricingTerm' => [
                'currencyCode' => '<string>',
                'rateCards' => [
                    [
                        'rateCard' => [
                            [
                                'dimensionKey' => '<string>',
                                'price' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'validityTerm' => [
                'agreementDuration' => '<string>',
                'agreementEndDate' => <DateTime>,
                'agreementStartDate' => <DateTime>,
                'type' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

SearchAgreements

$result = $client->searchAgreements([/* ... */]);
$promise = $client->searchAgreementsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->searchAgreements([
    'catalog' => '<string>',
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sort' => [
        'sortBy' => '<string>',
        'sortOrder' => 'ASCENDING|DESCENDING',
    ],
]);

Parameter Details

Result Syntax

[
    'agreementViewSummaries' => [
        [
            'acceptanceTime' => <DateTime>,
            'acceptor' => [
                'accountId' => '<string>',
            ],
            'agreementId' => '<string>',
            'agreementType' => '<string>',
            'endTime' => <DateTime>,
            'proposalSummary' => [
                'offerId' => '<string>',
                'resources' => [
                    [
                        'id' => '<string>',
                        'type' => '<string>',
                    ],
                    // ...
                ],
            ],
            'proposer' => [
                'accountId' => '<string>',
            ],
            'startTime' => <DateTime>,
            'status' => 'ACTIVE|ARCHIVED|CANCELLED|EXPIRED|RENEWED|REPLACED|ROLLED_BACK|SUPERSEDED|TERMINATED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.