Skip to content

Type definitions#

Index > AgreementService > Type definitions

Auto-generated documentation for AgreementService type annotations stubs module mypy-boto3-marketplace-agreement.

ByolPricingTermTypeDef#

# ByolPricingTermTypeDef definition

class ByolPricingTermTypeDef(TypedDict):
    type: NotRequired[str],

RecurringPaymentTermTypeDef#

# RecurringPaymentTermTypeDef definition

class RecurringPaymentTermTypeDef(TypedDict):
    billingPeriod: NotRequired[str],
    currencyCode: NotRequired[str],
    price: NotRequired[str],
    type: NotRequired[str],

SupportTermTypeDef#

# SupportTermTypeDef definition

class SupportTermTypeDef(TypedDict):
    refundPolicy: NotRequired[str],
    type: NotRequired[str],

ValidityTermTypeDef#

# ValidityTermTypeDef definition

class ValidityTermTypeDef(TypedDict):
    agreementDuration: NotRequired[str],
    agreementEndDate: NotRequired[datetime],
    agreementStartDate: NotRequired[datetime],
    type: NotRequired[str],

AcceptorTypeDef#

# AcceptorTypeDef definition

class AcceptorTypeDef(TypedDict):
    accountId: NotRequired[str],

ProposerTypeDef#

# ProposerTypeDef definition

class ProposerTypeDef(TypedDict):
    accountId: NotRequired[str],

DimensionTypeDef#

# DimensionTypeDef definition

class DimensionTypeDef(TypedDict):
    dimensionKey: str,
    dimensionValue: int,

ConstraintsTypeDef#

# ConstraintsTypeDef definition

class ConstraintsTypeDef(TypedDict):
    multipleDimensionSelection: NotRequired[str],
    quantityConfiguration: NotRequired[str],

RateCardItemTypeDef#

# RateCardItemTypeDef definition

class RateCardItemTypeDef(TypedDict):
    dimensionKey: NotRequired[str],
    price: NotRequired[str],

SelectorTypeDef#

# SelectorTypeDef definition

class SelectorTypeDef(TypedDict):
    type: NotRequired[str],
    value: NotRequired[str],

DescribeAgreementInputRequestTypeDef#

# DescribeAgreementInputRequestTypeDef definition

class DescribeAgreementInputRequestTypeDef(TypedDict):
    agreementId: str,

EstimatedChargesTypeDef#

# EstimatedChargesTypeDef definition

class EstimatedChargesTypeDef(TypedDict):
    agreementValue: NotRequired[str],
    currencyCode: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DocumentItemTypeDef#

# DocumentItemTypeDef definition

class DocumentItemTypeDef(TypedDict):
    type: NotRequired[str],
    url: NotRequired[str],
    version: NotRequired[str],

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    name: NotRequired[str],
    values: NotRequired[Sequence[str]],

GrantItemTypeDef#

# GrantItemTypeDef definition

class GrantItemTypeDef(TypedDict):
    dimensionKey: NotRequired[str],
    maxQuantity: NotRequired[int],

GetAgreementTermsInputRequestTypeDef#

# GetAgreementTermsInputRequestTypeDef definition

class GetAgreementTermsInputRequestTypeDef(TypedDict):
    agreementId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ScheduleItemTypeDef#

# ScheduleItemTypeDef definition

class ScheduleItemTypeDef(TypedDict):
    chargeAmount: NotRequired[str],
    chargeDate: NotRequired[datetime],

ResourceTypeDef#

# ResourceTypeDef definition

class ResourceTypeDef(TypedDict):
    id: NotRequired[str],
    type: NotRequired[str],

RenewalTermConfigurationTypeDef#

# RenewalTermConfigurationTypeDef definition

class RenewalTermConfigurationTypeDef(TypedDict):
    enableAutoRenew: bool,

SortTypeDef#

# SortTypeDef definition

class SortTypeDef(TypedDict):
    sortBy: NotRequired[str],
    sortOrder: NotRequired[SortOrderType],  # (1)
  1. See SortOrderType

ConfigurableUpfrontPricingTermConfigurationTypeDef#

# ConfigurableUpfrontPricingTermConfigurationTypeDef definition

class ConfigurableUpfrontPricingTermConfigurationTypeDef(TypedDict):
    dimensions: List[DimensionTypeDef],  # (1)
    selectorValue: str,
  1. See DimensionTypeDef

UsageBasedRateCardItemTypeDef#

# UsageBasedRateCardItemTypeDef definition

class UsageBasedRateCardItemTypeDef(TypedDict):
    rateCard: NotRequired[List[RateCardItemTypeDef]],  # (1)
  1. See RateCardItemTypeDef

ConfigurableUpfrontRateCardItemTypeDef#

# ConfigurableUpfrontRateCardItemTypeDef definition

class ConfigurableUpfrontRateCardItemTypeDef(TypedDict):
    constraints: NotRequired[ConstraintsTypeDef],  # (1)
    rateCard: NotRequired[List[RateCardItemTypeDef]],  # (2)
    selector: NotRequired[SelectorTypeDef],  # (3)
  1. See ConstraintsTypeDef
  2. See RateCardItemTypeDef
  3. See SelectorTypeDef

LegalTermTypeDef#

# LegalTermTypeDef definition

class LegalTermTypeDef(TypedDict):
    documents: NotRequired[List[DocumentItemTypeDef]],  # (1)
    type: NotRequired[str],
  1. See DocumentItemTypeDef

FixedUpfrontPricingTermTypeDef#

# FixedUpfrontPricingTermTypeDef definition

class FixedUpfrontPricingTermTypeDef(TypedDict):
    currencyCode: NotRequired[str],
    duration: NotRequired[str],
    grants: NotRequired[List[GrantItemTypeDef]],  # (1)
    price: NotRequired[str],
    type: NotRequired[str],
  1. See GrantItemTypeDef

FreeTrialPricingTermTypeDef#

# FreeTrialPricingTermTypeDef definition

class FreeTrialPricingTermTypeDef(TypedDict):
    duration: NotRequired[str],
    grants: NotRequired[List[GrantItemTypeDef]],  # (1)
    type: NotRequired[str],
  1. See GrantItemTypeDef

PaymentScheduleTermTypeDef#

# PaymentScheduleTermTypeDef definition

class PaymentScheduleTermTypeDef(TypedDict):
    currencyCode: NotRequired[str],
    schedule: NotRequired[List[ScheduleItemTypeDef]],  # (1)
    type: NotRequired[str],
  1. See ScheduleItemTypeDef

ProposalSummaryTypeDef#

# ProposalSummaryTypeDef definition

class ProposalSummaryTypeDef(TypedDict):
    offerId: NotRequired[str],
    resources: NotRequired[List[ResourceTypeDef]],  # (1)
  1. See ResourceTypeDef

RenewalTermTypeDef#

# RenewalTermTypeDef definition

class RenewalTermTypeDef(TypedDict):
    configuration: NotRequired[RenewalTermConfigurationTypeDef],  # (1)
    type: NotRequired[str],
  1. See RenewalTermConfigurationTypeDef

SearchAgreementsInputRequestTypeDef#

# SearchAgreementsInputRequestTypeDef definition

class SearchAgreementsInputRequestTypeDef(TypedDict):
    catalog: NotRequired[str],
    filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sort: NotRequired[SortTypeDef],  # (2)
  1. See FilterTypeDef
  2. See SortTypeDef

UsageBasedPricingTermTypeDef#

# UsageBasedPricingTermTypeDef definition

class UsageBasedPricingTermTypeDef(TypedDict):
    currencyCode: NotRequired[str],
    rateCards: NotRequired[List[UsageBasedRateCardItemTypeDef]],  # (1)
    type: NotRequired[str],
  1. See UsageBasedRateCardItemTypeDef

ConfigurableUpfrontPricingTermTypeDef#

# ConfigurableUpfrontPricingTermTypeDef definition

class ConfigurableUpfrontPricingTermTypeDef(TypedDict):
    configuration: NotRequired[ConfigurableUpfrontPricingTermConfigurationTypeDef],  # (1)
    currencyCode: NotRequired[str],
    rateCards: NotRequired[List[ConfigurableUpfrontRateCardItemTypeDef]],  # (2)
    type: NotRequired[str],
  1. See ConfigurableUpfrontPricingTermConfigurationTypeDef
  2. See ConfigurableUpfrontRateCardItemTypeDef

AgreementViewSummaryTypeDef#

# AgreementViewSummaryTypeDef definition

class AgreementViewSummaryTypeDef(TypedDict):
    acceptanceTime: NotRequired[datetime],
    acceptor: NotRequired[AcceptorTypeDef],  # (1)
    agreementId: NotRequired[str],
    agreementType: NotRequired[str],
    endTime: NotRequired[datetime],
    proposalSummary: NotRequired[ProposalSummaryTypeDef],  # (2)
    proposer: NotRequired[ProposerTypeDef],  # (3)
    startTime: NotRequired[datetime],
    status: NotRequired[AgreementStatusType],  # (4)
  1. See AcceptorTypeDef
  2. See ProposalSummaryTypeDef
  3. See ProposerTypeDef
  4. See AgreementStatusType

DescribeAgreementOutputTypeDef#

# DescribeAgreementOutputTypeDef definition

class DescribeAgreementOutputTypeDef(TypedDict):
    acceptanceTime: datetime,
    acceptor: AcceptorTypeDef,  # (1)
    agreementId: str,
    agreementType: str,
    endTime: datetime,
    estimatedCharges: EstimatedChargesTypeDef,  # (2)
    proposalSummary: ProposalSummaryTypeDef,  # (3)
    proposer: ProposerTypeDef,  # (4)
    startTime: datetime,
    status: AgreementStatusType,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See AcceptorTypeDef
  2. See EstimatedChargesTypeDef
  3. See ProposalSummaryTypeDef
  4. See ProposerTypeDef
  5. See