{ "smithy": "2.0", "shapes": { "com.amazonaws.marketplaceagreement#AWSAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.marketplaceagreement#AWSMPCommerceService_v20200301": { "type": "service", "version": "2020-03-01", "operations": [ { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementApproval" }, { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementCancellationRequest" }, { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementPaymentRequest" }, { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementRequest" }, { "target": "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentRequest" }, { "target": "com.amazonaws.marketplaceagreement#CancelAgreement" }, { "target": "com.amazonaws.marketplaceagreement#CancelAgreementCancellationRequest" }, { "target": "com.amazonaws.marketplaceagreement#CancelAgreementPaymentRequest" }, { "target": "com.amazonaws.marketplaceagreement#CancelAgreementRequest" }, { "target": "com.amazonaws.marketplaceagreement#CreateAgreementRequest" }, { "target": "com.amazonaws.marketplaceagreement#DescribeAgreement" }, { "target": "com.amazonaws.marketplaceagreement#GetAgreementApproval" }, { "target": "com.amazonaws.marketplaceagreement#GetAgreementCancellationRequest" }, { "target": "com.amazonaws.marketplaceagreement#GetAgreementContacts" }, { "target": "com.amazonaws.marketplaceagreement#GetAgreementEntitlements" }, { "target": "com.amazonaws.marketplaceagreement#GetAgreementPaymentRequest" }, { "target": "com.amazonaws.marketplaceagreement#GetAgreementRequest" }, { "target": "com.amazonaws.marketplaceagreement#GetAgreementRequestApprovalPlans" }, { "target": "com.amazonaws.marketplaceagreement#GetAgreementRequestTerms" }, { "target": "com.amazonaws.marketplaceagreement#GetAgreementTerms" }, { "target": "com.amazonaws.marketplaceagreement#GetBillingAdjustmentRequest" }, { "target": "com.amazonaws.marketplaceagreement#ListAgreementApprovals" }, { "target": "com.amazonaws.marketplaceagreement#ListAgreementCancellationRequests" }, { "target": "com.amazonaws.marketplaceagreement#ListAgreementCharges" }, { "target": "com.amazonaws.marketplaceagreement#ListAgreementInvoiceLineItems" }, { "target": "com.amazonaws.marketplaceagreement#ListAgreementPaymentRequests" }, { "target": "com.amazonaws.marketplaceagreement#ListAgreementRequests" }, { "target": "com.amazonaws.marketplaceagreement#ListBillingAdjustmentRequests" }, { "target": "com.amazonaws.marketplaceagreement#RejectAgreementApproval" }, { "target": "com.amazonaws.marketplaceagreement#RejectAgreementCancellationRequest" }, { "target": "com.amazonaws.marketplaceagreement#RejectAgreementPaymentRequest" }, { "target": "com.amazonaws.marketplaceagreement#SearchAgreements" }, { "target": "com.amazonaws.marketplaceagreement#SendAgreementCancellationRequest" }, { "target": "com.amazonaws.marketplaceagreement#SendAgreementPaymentRequest" }, { "target": "com.amazonaws.marketplaceagreement#StartAgreementApprovals" }, { "target": "com.amazonaws.marketplaceagreement#UpdatePurchaseOrders" } ], "traits": { "aws.api#service": { "sdkId": "Marketplace Agreement", "endpointPrefix": "agreement-marketplace" }, "aws.auth#sigv4": { "name": "aws-marketplace" }, "aws.protocols#awsJson1_0": {}, "smithy.api#documentation": "
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 and buyers manage their product-related agreements, including listing, searching, creating, and filtering agreements.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#title": "AWS Marketplace Agreement Service", "smithy.protocols#rpcv2Cbor": {}, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://agreement-marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://agreement-marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://agreement-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://agreement-marketplace.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://agreement-marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://agreement-marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://agreement-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://agreement-marketplace.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://agreement-marketplace-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://agreement-marketplace.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://agreement-marketplace-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://agreement-marketplace.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://agreement-marketplace-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://agreement-marketplace.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://agreement-marketplace.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.marketplaceagreement#AcceptAgreementApproval": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementApprovalInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementApprovalOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows the management account or a delegated administrator of the buyer's AWS organization to approve an agreement approval that is in PENDING_APPROVAL status, as the organization administrator approver or on behalf of another approver. Once every level is approved, the agreement approval transitions to APPROVED status. You can optionally provide purchase order references and a note.
The approval decision for an agreement approval that the buyer's organization requires.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#AcceptAgreementApprovalOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#AcceptAgreementCancellationRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementCancellationRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementCancellationRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status. Once accepted, the cancellation request transitions to APPROVED status and the agreement cancellation will be processed.
Only cancellation requests in PENDING_APPROVAL status can be accepted. A ConflictException is thrown if the cancellation request is in any other status.
The unique identifier of the agreement associated with the cancellation request.
", "smithy.api#required": {} } }, "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the cancellation request to accept.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#AcceptAgreementCancellationRequestOutput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this cancellation request.
" } }, "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the accepted cancellation request.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatus", "traits": { "smithy.api#documentation": "The updated status of the cancellation request, which is APPROVED.
The original reason code provided when the cancellation request was created.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the cancellation reason, if provided.
" } }, "createdAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was originally created.
" } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was accepted.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#AcceptAgreementPaymentRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementPaymentRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementPaymentRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows buyers (acceptors) to accept a payment request that is in PENDING_APPROVAL status. Once accepted, the payment request transitions to APPROVED status and the charge will be processed. Buyers can optionally provide a purchase order reference for their internal tracking.
Only payment requests in PENDING_APPROVAL status can be accepted. A ConflictException is thrown if the payment request is in any other status.
The unique identifier of the payment request to accept.
", "smithy.api#required": {} } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with the payment request.
", "smithy.api#required": {} } }, "purchaseOrderReference": { "target": "com.amazonaws.marketplaceagreement#PurchaseOrderReference", "traits": { "smithy.api#documentation": "An optional purchase order reference that buyers can provide to associate the payment request with their internal purchase order system.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#AcceptAgreementPaymentRequestOutput": { "type": "structure", "members": { "paymentRequestId": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the accepted payment request.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this payment request.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestStatus", "traits": { "smithy.api#documentation": "The updated status of the payment request, which is APPROVED.
The descriptive name of the payment request.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the payment request, if provided.
" } }, "chargeAmount": { "target": "com.amazonaws.marketplaceagreement#PositiveAmountUpto8Decimals", "traits": { "smithy.api#documentation": "The amount that was approved to be charged.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the charge amount.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was originally created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was accepted.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#AcceptAgreementRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#AcceptAgreementRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ServiceQuotaExceededException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Accepts an agreement request to finalize the agreement. The acceptor can optionally provide purchase orders to associate with the agreement charges.
" } }, "com.amazonaws.marketplaceagreement#AcceptAgreementRequestInput": { "type": "structure", "members": { "agreementRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement request.
", "smithy.api#required": {} } }, "purchaseOrders": { "target": "com.amazonaws.marketplaceagreement#PurchaseOrders", "traits": { "smithy.api#documentation": "A list of purchase orders associated with accepting a marketplace agreement request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#AcceptAgreementRequestOutput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement created or modified by accepting the agreement request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#AcceptedTerm": { "type": "union", "members": { "legalTerm": { "target": "com.amazonaws.marketplaceagreement#LegalTerm", "traits": { "smithy.api#documentation": "Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).
" } }, "supportTerm": { "target": "com.amazonaws.marketplaceagreement#SupportTerm", "traits": { "smithy.api#documentation": "Defines the customer support available for the acceptors when they purchase the software.
" } }, "renewalTerm": { "target": "com.amazonaws.marketplaceagreement#RenewalTerm", "traits": { "smithy.api#documentation": "Defines that on graceful expiration of the agreement (when the agreement ends on its pre-defined end date), a new agreement will be created using the accepted terms on the existing agreement. In other words, the agreement will be renewed. Presence of RenewalTerm in the offer document means that auto-renewal is allowed. The acceptor will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. The acceptor can also change this flag from True to False or False to True, within the limits set by LockoutPeriod and MaxRenewals. Setting the flag to True doesn't by itself guarantee that the agreement renews, because the proposer can also opt out.
Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.
" } }, "configurableUpfrontPricingTerm": { "target": "com.amazonaws.marketplaceagreement#ConfigurableUpfrontPricingTerm", "traits": { "smithy.api#documentation": "Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
" } }, "byolPricingTerm": { "target": "com.amazonaws.marketplaceagreement#ByolPricingTerm", "traits": { "smithy.api#documentation": "Enables you and your customers to move your existing agreements to AWS Marketplace. The customer won't be charged for product usage in AWS Marketplace because they already paid for the product outside of AWS Marketplace.
" } }, "recurringPaymentTerm": { "target": "com.amazonaws.marketplaceagreement#RecurringPaymentTerm", "traits": { "smithy.api#documentation": "Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.
" } }, "validityTerm": { "target": "com.amazonaws.marketplaceagreement#ValidityTerm", "traits": { "smithy.api#documentation": "Defines the conditions that will keep an agreement created from this offer valid.
" } }, "paymentScheduleTerm": { "target": "com.amazonaws.marketplaceagreement#PaymentScheduleTerm", "traits": { "smithy.api#documentation": "Defines an installment-based pricing model where customers are charged a fixed price on different dates during the agreement validity period. This is used most commonly for flexible payment schedule pricing.
" } }, "freeTrialPricingTerm": { "target": "com.amazonaws.marketplaceagreement#FreeTrialPricingTerm", "traits": { "smithy.api#documentation": "Defines a short-term free pricing model where the buyers aren't charged anything within a specified limit.
" } }, "fixedUpfrontPricingTerm": { "target": "com.amazonaws.marketplaceagreement#FixedUpfrontPricingTerm", "traits": { "smithy.api#documentation": "Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.
" } }, "variablePaymentTerm": { "target": "com.amazonaws.marketplaceagreement#VariablePaymentTerm", "traits": { "smithy.api#documentation": "Defines a payment model where sellers can submit variable payment requests up to a maximum charge amount, with configurable approval strategies and expiration timelines.
" } }, "netPaymentTerm": { "target": "com.amazonaws.marketplaceagreement#NetPaymentTerm", "traits": { "smithy.api#documentation": "Defines the net payment due period for the agreement, specifying when payment is due after an invoice is issued.
" } } }, "traits": { "smithy.api#documentation": "A subset of terms proposed by the proposer, which have been accepted by the acceptor as part of agreement creation.
" } }, "com.amazonaws.marketplaceagreement#AcceptedTermList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AcceptedTerm" } }, "com.amazonaws.marketplaceagreement#Acceptor": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.marketplaceagreement#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the acceptor.
" } } }, "traits": { "smithy.api#documentation": "The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.
The first name of the acceptor contact.
", "smithy.api#required": {} } }, "lastName": { "target": "com.amazonaws.marketplaceagreement#PersonName", "traits": { "smithy.api#documentation": "The last name of the acceptor contact.
", "smithy.api#required": {} } }, "emailAddress": { "target": "com.amazonaws.marketplaceagreement#EmailAddress", "traits": { "smithy.api#documentation": "The email address of the acceptor contact.
", "smithy.api#required": {} } }, "companyName": { "target": "com.amazonaws.marketplaceagreement#ContactCompanyName", "traits": { "smithy.api#documentation": "The name of the company that the acceptor contact represents.
", "smithy.api#required": {} } }, "countryCode": { "target": "com.amazonaws.marketplaceagreement#CountryCode", "traits": { "smithy.api#documentation": "The ISO-3166 two-letter country code for the acceptor contact.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The contact information of the acceptor.
", "smithy.api#sensitive": {} } }, "com.amazonaws.marketplaceagreement#AccessDeniedException": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.marketplaceagreement#RequestId", "traits": { "smithy.api#documentation": "The unique identifier for the error.
" } }, "message": { "target": "com.amazonaws.marketplaceagreement#ExceptionMessage", "traits": { "smithy.api#documentation": "Description of the error.
" } }, "reason": { "target": "com.amazonaws.marketplaceagreement#AccessDeniedExceptionReason", "traits": { "smithy.api#documentation": "The reason for the access denied exception.
" } } }, "traits": { "smithy.api#documentation": "User does not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.marketplaceagreement#AccessDeniedExceptionReason": { "type": "enum", "members": { "INVALID_ACCOUNT_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ACCOUNT_STATE" } }, "DENIED_BY_PRIVATE_MARKETPLACE_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DENIED_BY_PRIVATE_MARKETPLACE_POLICY" } }, "FAILED_KYC_COMPLIANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_KYC_COMPLIANCE" } }, "MISSING_MFA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_MFA" } }, "INVALID_ACCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ACCESS" } } } }, "com.amazonaws.marketplaceagreement#AgreementApprovalDeployedOnAws": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.marketplaceagreement#AgreementApprovalId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^apr-[A-Za-z0-9]+$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalLevelName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalNote": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.marketplaceagreement#AgreementApprovalOfferId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^\\S{1,64}$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalOfferSetId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^\\S{1,50}$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalPartyType": { "type": "enum", "members": { "REQUESTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUESTER" } }, "AWS_ORGANIZATION_ADMIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_ORGANIZATION_ADMIN" } } } }, "com.amazonaws.marketplaceagreement#AgreementApprovalPlan": { "type": "union", "members": { "buyerAgreementApprovalPlan": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlan", "traits": { "smithy.api#documentation": "An approval plan that the buyer's organization requires.
" } } }, "traits": { "smithy.api#documentation": "An approval plan that applies to an agreement request.
" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalPlanInput": { "type": "union", "members": { "buyerAgreementApprovalPlanInput": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanInput", "traits": { "smithy.api#documentation": "An approval plan that the buyer's organization requires.
" } } }, "traits": { "smithy.api#documentation": "The approval plan to start an agreement approval for.
" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalPlanInputs": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPlanInput" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplaceagreement#AgreementApprovalPlanName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalPlanReference": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^aplan-[A-Za-z0-9]+$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalPlans": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPlan" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplaceagreement#AgreementApprovalProposalSummary": { "type": "structure", "members": { "offerId": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalOfferId", "traits": { "smithy.api#documentation": "The unique identifier of the offer in AWS Marketplace.
", "smithy.api#required": {} } }, "offerSetId": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalOfferSetId", "traits": { "smithy.api#documentation": "A unique identifier for the offer set containing this offer.
" } }, "resources": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalResources", "traits": { "smithy.api#documentation": "The list of resources involved in the agreement.
" } }, "visibilityScope": { "target": "com.amazonaws.marketplaceagreement#OfferVisibilityScope", "traits": { "smithy.api#documentation": "The visibility of the offer. Valid values are PUBLIC and PRIVATE.
A summary of the proposal received from the proposer.
" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalProposer": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.marketplaceagreement#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the proposer.
", "smithy.api#required": {} } }, "legalName": { "target": "com.amazonaws.marketplaceagreement#ProposerLegalName", "traits": { "smithy.api#documentation": "The legal name of the proposer.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.
The unique identifier of the charge to associate the purchase order with. Use GetAgreementRequest to retrieve the charges of the agreement request.
The purchase order reference to associate with the charge.
" } } }, "traits": { "smithy.api#documentation": "A purchase order reference for a charge on the agreement request.
" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalPurchaseOrders": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPurchaseOrder" }, "traits": { "smithy.api#length": { "min": 1, "max": 86 } } }, "com.amazonaws.marketplaceagreement#AgreementApprovalRequester": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.marketplaceagreement#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the requester, which is the buyer of the agreement request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The account that started an agreement approval.
" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalResource": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the resource.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalResourceType", "traits": { "smithy.api#documentation": "Type of the resource, which is the product (for example, SaaSProduct, AmiProduct, ContainerProduct).
The name of the product.
", "smithy.api#required": {} } }, "deployedOnAws": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalDeployedOnAws", "traits": { "smithy.api#documentation": "Whether the product is deployed on AWS (for example, DEPLOYED).
A resource involved in the agreement, such as a product.
" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_/-]+$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[^\\p{C}]+$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalResourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9]+$" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalResources": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalResource" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.marketplaceagreement#AgreementApprovalStatus": { "type": "enum", "members": { "PENDING_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_APPROVAL" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } } } }, "com.amazonaws.marketplaceagreement#AgreementApprovalSummaries": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalSummary" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalSummary": { "type": "structure", "members": { "approvalType": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalType", "traits": { "smithy.api#documentation": "The type of the agreement approval. The only value is BUYER_AGREEMENT_APPROVAL, an approval that the buyer's organization requires before the agreement request can be accepted.
The unique identifier of the agreement request that the agreement approval is for.
", "smithy.api#required": {} } }, "agreementApprovalId": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement approval.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalName", "traits": { "smithy.api#documentation": "The descriptive name of the agreement approval.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalStatus", "traits": { "smithy.api#documentation": "The current status of the agreement approval. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and CANCELLED.
The date and time when the agreement approval was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the agreement approval was last updated.
", "smithy.api#required": {} } }, "startedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when approvers could start acting on the agreement approval.
" } }, "expiresAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the agreement approval expires if it isn't approved or rejected.
" } }, "approvalNeededBy": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time by which the agreement approval must be completed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Summary view of an agreement approval.
" } }, "com.amazonaws.marketplaceagreement#AgreementApprovalType": { "type": "enum", "members": { "BUYER_AGREEMENT_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUYER_AGREEMENT_APPROVAL" } } } }, "com.amazonaws.marketplaceagreement#AgreementCancellationRequestCancellationReason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.marketplaceagreement#AgreementCancellationRequestDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^acr-[a-zA-Z0-9]+$" } }, "com.amazonaws.marketplaceagreement#AgreementCancellationRequestReasonCode": { "type": "enum", "members": { "INCORRECT_TERMS_ACCEPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INCORRECT_TERMS_ACCEPTED" } }, "REPLACING_AGREEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPLACING_AGREEMENT" } }, "TEST_AGREEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEST_AGREEMENT" } }, "ALTERNATIVE_PROCUREMENT_CHANNEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALTERNATIVE_PROCUREMENT_CHANNEL" } }, "PRODUCT_DISCONTINUED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRODUCT_DISCONTINUED" } }, "UNINTENDED_RENEWAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNINTENDED_RENEWAL" } }, "BUYER_DISSATISFACTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUYER_DISSATISFACTION" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } } }, "com.amazonaws.marketplaceagreement#AgreementCancellationRequestRejectionReason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatus": { "type": "enum", "members": { "PENDING_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_APPROVAL" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } }, "VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION_FAILED" } } } }, "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatusMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.marketplaceagreement#AgreementCancellationRequestSummary": { "type": "structure", "members": { "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the cancellation request.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this cancellation request.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatus", "traits": { "smithy.api#documentation": "The current status of the cancellation request. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED.
The reason code provided for the cancellation.
" } }, "agreementType": { "target": "com.amazonaws.marketplaceagreement#AgreementType", "traits": { "smithy.api#documentation": "The type of agreement.
" } }, "catalog": { "target": "com.amazonaws.marketplaceagreement#Catalog", "traits": { "smithy.api#documentation": "The catalog in which the agreement was created.
" } }, "createdAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was created.
" } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was last updated.
" } } }, "traits": { "smithy.api#documentation": "Summary view of an agreement cancellation request.
" } }, "com.amazonaws.marketplaceagreement#AgreementCancellationRequestSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestSummary" } }, "com.amazonaws.marketplaceagreement#AgreementEntitlement": { "type": "structure", "members": { "resource": { "target": "com.amazonaws.marketplaceagreement#Resource", "traits": { "smithy.api#documentation": "The resource that the entitlement is provisioned to, such as a product.
" } }, "type": { "target": "com.amazonaws.marketplaceagreement#EntitlementType", "traits": { "smithy.api#documentation": "The type of entitlement.
" } }, "registrationToken": { "target": "com.amazonaws.marketplaceagreement#RegistrationToken", "traits": { "smithy.api#documentation": "A short-lived token required by acceptors to register their account with the product provider. The token is only valid for 30 minutes after creation and is only applicable for purchase agreements.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementEntitlementStatus", "traits": { "smithy.api#documentation": "The current state of an entitlement.
" } }, "statusReasonCode": { "target": "com.amazonaws.marketplaceagreement#AgreementEntitlementStatusReasonCode", "traits": { "smithy.api#documentation": "Provides more information about the status of an entitlement.
" } }, "licenseArn": { "target": "com.amazonaws.marketplaceagreement#AwsArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement.
" } } }, "traits": { "smithy.api#documentation": "Represents an entitlement associated with an agreement, including the provisioning status, resource, and type.
" } }, "com.amazonaws.marketplaceagreement#AgreementEntitlementList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementEntitlement" } }, "com.amazonaws.marketplaceagreement#AgreementEntitlementStatus": { "type": "enum", "members": { "PROVISIONED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONED" } }, "SCHEDULED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCHEDULED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "DEPROVISIONED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPROVISIONED" } } } }, "com.amazonaws.marketplaceagreement#AgreementEntitlementStatusReasonCode": { "type": "enum", "members": { "PROVISIONING_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONING_IN_PROGRESS" } }, "FUTURE_START_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FUTURE_START_DATE" } }, "INVALID_PAYMENT_INSTRUMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PAYMENT_INSTRUMENT" } }, "INCOMPATIBLE_CURRENCY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INCOMPATIBLE_CURRENCY" } }, "ACCOUNT_SUSPENDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_SUSPENDED" } }, "UNSUPPORTED_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_OPERATION" } }, "AGREEMENT_INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGREEMENT_INACTIVE" } }, "AGREEMENT_ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGREEMENT_ACTIVE" } }, "PRODUCT_RESTRICTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRODUCT_RESTRICTED" } } } }, "com.amazonaws.marketplaceagreement#AgreementId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_/-]+$" } }, "com.amazonaws.marketplaceagreement#AgreementInvoiceLineItemGroupSummaries": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementInvoiceLineItemGroupSummary" } }, "com.amazonaws.marketplaceagreement#AgreementInvoiceLineItemGroupSummary": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
" } }, "invoiceId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The identifier of the invoice for this group.
" } }, "pricingCurrencyAmount": { "target": "com.amazonaws.marketplaceagreement#PricingCurrencyAmount", "traits": { "smithy.api#documentation": "Monetary amounts for this invoice group.
" } }, "invoiceBillingPeriod": { "target": "com.amazonaws.marketplaceagreement#InvoiceBillingPeriod", "traits": { "smithy.api#documentation": "The billing period associated with this group.
" } }, "issuedTime": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the invoice containing this group was created.
" } }, "invoiceType": { "target": "com.amazonaws.marketplaceagreement#InvoiceType", "traits": { "smithy.api#documentation": "The type of invoice. Valid values are INVOICE and CREDIT_MEMO.
The entity that issues the invoice.
" } } }, "traits": { "smithy.api#documentation": "A summary of grouped billing data for an agreement invoice line item.
" } }, "com.amazonaws.marketplaceagreement#AgreementProposalId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^(at-|ap-)[A-Za-z0-9]+$" } }, "com.amazonaws.marketplaceagreement#AgreementRequestId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^ar-[A-Za-z0-9]+$" } }, "com.amazonaws.marketplaceagreement#AgreementRequestStatus": { "type": "enum", "members": { "DRAFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DRAFT" } }, "PENDING_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_APPROVAL" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "ACCEPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } } } }, "com.amazonaws.marketplaceagreement#AgreementRequestSummary": { "type": "structure", "members": { "agreementRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement request.
" } }, "agreementType": { "target": "com.amazonaws.marketplaceagreement#AgreementType", "traits": { "smithy.api#documentation": "The type of agreement (for example, PurchaseAgreement).
The current status of the agreement request. Possible values include DRAFT, PENDING_APPROVAL, APPROVED, ACCEPTED, REJECTED, and CANCELLED.
The unique identifier of the agreement that the agreement request is for.
" } }, "proposalSummary": { "target": "com.amazonaws.marketplaceagreement#ProposalSummary", "traits": { "smithy.api#documentation": "A summary of the proposal received from the proposer.
" } } }, "traits": { "smithy.api#documentation": "Summary view of an agreement request.
" } }, "com.amazonaws.marketplaceagreement#AgreementRequestSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementRequestSummary" } }, "com.amazonaws.marketplaceagreement#AgreementRequestTerm": { "type": "union", "members": { "legalTerm": { "target": "com.amazonaws.marketplaceagreement#LegalTerm", "traits": { "smithy.api#documentation": "Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).
" } }, "supportTerm": { "target": "com.amazonaws.marketplaceagreement#SupportTerm", "traits": { "smithy.api#documentation": "Defines the customer support available for the acceptors when they purchase the software.
" } }, "renewalTerm": { "target": "com.amazonaws.marketplaceagreement#RenewalTerm", "traits": { "smithy.api#documentation": "Defines that on graceful expiration of the agreement (when the agreement ends on its pre-defined end date), a new agreement will be created using the accepted terms on the existing agreement. In other words, the agreement will be renewed. Presence of RenewalTerm in the offer document means that auto-renewal is allowed. The acceptor will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. The acceptor can also change this flag from True to False or False to True, within the limits set by LockoutPeriod and MaxRenewals. Setting the flag to True doesn't by itself guarantee that the agreement renews, because the proposer can also opt out.
Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.
" } }, "configurableUpfrontPricingTerm": { "target": "com.amazonaws.marketplaceagreement#ConfigurableUpfrontPricingTerm", "traits": { "smithy.api#documentation": "Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
" } }, "byolPricingTerm": { "target": "com.amazonaws.marketplaceagreement#ByolPricingTerm", "traits": { "smithy.api#documentation": "Enables you and your customers to move your existing agreements to AWS Marketplace. The customer won't be charged for product usage in AWS Marketplace because they already paid for the product outside of AWS Marketplace.
" } }, "recurringPaymentTerm": { "target": "com.amazonaws.marketplaceagreement#RecurringPaymentTerm", "traits": { "smithy.api#documentation": "Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.
" } }, "validityTerm": { "target": "com.amazonaws.marketplaceagreement#ValidityTerm", "traits": { "smithy.api#documentation": "Defines the conditions that will keep an agreement created from this offer valid.
" } }, "paymentScheduleTerm": { "target": "com.amazonaws.marketplaceagreement#PaymentScheduleTerm", "traits": { "smithy.api#documentation": "Defines an installment-based pricing model where customers are charged a fixed price on different dates during the agreement validity period. This is used most commonly for flexible payment schedule pricing.
" } }, "freeTrialPricingTerm": { "target": "com.amazonaws.marketplaceagreement#FreeTrialPricingTerm", "traits": { "smithy.api#documentation": "Defines a short-term free pricing model where the buyers aren't charged anything within a specified limit.
" } }, "fixedUpfrontPricingTerm": { "target": "com.amazonaws.marketplaceagreement#FixedUpfrontPricingTerm", "traits": { "smithy.api#documentation": "Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.
" } }, "variablePaymentTerm": { "target": "com.amazonaws.marketplaceagreement#VariablePaymentTerm", "traits": { "smithy.api#documentation": "Defines a payment model where sellers can submit variable payment requests up to a maximum charge amount, with configurable approval strategies and expiration timelines.
" } }, "netPaymentTerm": { "target": "com.amazonaws.marketplaceagreement#NetPaymentTerm", "traits": { "smithy.api#documentation": "Defines the net payment due period for the agreement, specifying when payment is due after an invoice is issued.
" } } }, "traits": { "smithy.api#documentation": "A subset of terms proposed by the proposer, which have been requested by the acceptor as part of the agreement request.
" } }, "com.amazonaws.marketplaceagreement#AgreementRequestTermList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementRequestTerm" } }, "com.amazonaws.marketplaceagreement#AgreementRequestTermsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 10, "max": 50 } } }, "com.amazonaws.marketplaceagreement#AgreementResourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z]+$" } }, "com.amazonaws.marketplaceagreement#AgreementStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "ARCHIVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "RENEWED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RENEWED" } }, "REPLACED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPLACED" } }, "ROLLED_BACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLED_BACK" } }, "SUPERSEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUPERSEDED" } }, "TERMINATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TERMINATED" } } } }, "com.amazonaws.marketplaceagreement#AgreementType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z]+$" } }, "com.amazonaws.marketplaceagreement#AgreementViewSummary": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
" } }, "acceptanceTime": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time that the agreement was accepted.
" } }, "startTime": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the agreement starts.
" } }, "endTime": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don't have end dates.
The date and time when the agreement was last updated. An agreement is updated when any of its attributes or accepted terms change. Amendments, renewals, and a party changing whether the agreement renews are all examples.
Use the BeforeLastUpdateTime and AfterLastUpdateTime filters to search on this value, and LastUpdateTime as the SortBy value to sort by it. Sorting by LastUpdateTime is supported only when PartyType is Proposer.
The type of agreement.
" } }, "acceptor": { "target": "com.amazonaws.marketplaceagreement#Acceptor", "traits": { "smithy.api#documentation": "Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.
Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.
A summary of the proposal
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementStatus", "traits": { "smithy.api#documentation": "The current status of the agreement.
" } }, "entitlements": { "target": "com.amazonaws.marketplaceagreement#EntitlementList", "traits": { "smithy.api#documentation": "A list of entitlements associated with the agreement.
" } }, "initialAgreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. You can also use it as the InitialAgreementId filter value to return every agreement in the same chain.
The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.
Types include:
RENEW \u2013 A new agreement is created from the accepted terms of this agreement.
REPLACE \u2013 A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.
EXPIRE \u2013 The agreement ends and isn't renewed or replaced.
The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.
More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.
The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.
Reason codes include:
PROPOSER_RENEW_OPTED_OUT \u2013 The proposer opted out of renewing the agreement.
ACCEPTOR_RENEW_OPTED_OUT \u2013 The acceptor opted out of renewing the agreement.
NO_RENEWAL_TERM \u2013 The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.
RENEWAL_LIMIT_EXHAUSTED \u2013 The agreement reached the maximum number of renewals allowed by its renewal term.
The date and time when the free trial of the agreement ends. This field is present only when the agreement includes a free trial.
For an agreement that includes both a free trial and usage-based pricing, the agreement converts to paid usage at this time.
" } }, "includesContactOfType": { "target": "com.amazonaws.marketplaceagreement#ContactTypeList", "traits": { "smithy.api#documentation": "The types of contact information on file for the agreement. For example, ACCEPTOR indicates that the acceptor's contact information is on file, which you can retrieve with GetAgreementContacts.
A summary of the agreement, including top-level attributes (for example, the agreement ID, proposer, and acceptor).
" } }, "com.amazonaws.marketplaceagreement#AgreementViewSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#AgreementViewSummary" } }, "com.amazonaws.marketplaceagreement#ApprovalRequirement": { "type": "enum", "members": { "REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUIRED" } }, "NOT_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_REQUIRED" } } } }, "com.amazonaws.marketplaceagreement#Approver": { "type": "union", "members": { "emailApprover": { "target": "com.amazonaws.marketplaceagreement#EmailApprover", "traits": { "smithy.api#documentation": "An approver who is identified by an email address.
" } }, "procurementToolApprover": { "target": "com.amazonaws.marketplaceagreement#ProcurementToolApprover", "traits": { "smithy.api#documentation": "A procurement system that approves through the buyer's procurement integration.
" } }, "awsOrganizationAdminApprover": { "target": "com.amazonaws.marketplaceagreement#AwsOrganizationAdminApprover", "traits": { "smithy.api#documentation": "The administrators of the buyer's AWS organization.
" } } }, "traits": { "smithy.api#documentation": "An approver in an approval plan.
" } }, "com.amazonaws.marketplaceagreement#ApproverName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.marketplaceagreement#ApproverOutcome": { "type": "union", "members": { "emailApproverOutcome": { "target": "com.amazonaws.marketplaceagreement#EmailApproverOutcome", "traits": { "smithy.api#documentation": "The decision of an approver who is identified by an email address.
" } }, "procurementToolApproverOutcome": { "target": "com.amazonaws.marketplaceagreement#ProcurementToolApproverOutcome", "traits": { "smithy.api#documentation": "The decision of a procurement system.
" } }, "awsOrganizationApproverOutcome": { "target": "com.amazonaws.marketplaceagreement#AwsOrganizationApproverOutcome", "traits": { "smithy.api#documentation": "The decision of the administrators of the buyer's AWS organization.
" } } }, "traits": { "smithy.api#documentation": "An approver in an agreement approval and the approver's decision.
" } }, "com.amazonaws.marketplaceagreement#ApproverOutcomeId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^aprout-[A-Za-z0-9-]+$" } }, "com.amazonaws.marketplaceagreement#ApproverOutcomeStatus": { "type": "enum", "members": { "QUEUED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUEUED" } }, "PENDING_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_APPROVAL" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "SKIPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIPPED" } } } }, "com.amazonaws.marketplaceagreement#AwsArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" } }, "com.amazonaws.marketplaceagreement#AwsOrganizationAdminApprover": { "type": "structure", "members": { "organizationId": { "target": "com.amazonaws.marketplaceagreement#OrganizationId", "traits": { "smithy.api#documentation": "The ID of the AWS organization.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An approver that represents the administrators of the buyer's AWS organization. The management account or a delegated administrator of the organization can decide for this approver.
" } }, "com.amazonaws.marketplaceagreement#AwsOrganizationApproverOutcome": { "type": "structure", "members": { "note": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalNote", "traits": { "smithy.api#documentation": "The note that the approver provided with the decision.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#ApproverOutcomeStatus", "traits": { "smithy.api#documentation": "The decision status of the approver. Possible values include QUEUED, PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and SKIPPED.
The date and time when the decision was last updated.
", "smithy.api#required": {} } }, "approverOutcomeId": { "target": "com.amazonaws.marketplaceagreement#ApproverOutcomeId", "traits": { "smithy.api#documentation": "The unique identifier of this approver in the agreement approval.
" } }, "purchaseOrders": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPurchaseOrders", "traits": { "smithy.api#documentation": "The purchase order references that the approver provided with the decision.
" } } }, "traits": { "smithy.api#documentation": "The decision of the administrators of the buyer's AWS organization. The management account or a delegated administrator of the organization makes this decision.
" } }, "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentError": { "type": "structure", "members": { "code": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentErrorCode", "traits": { "smithy.api#documentation": "The error code indicating the reason for failure.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A human-readable message describing the error.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.marketplaceagreement#ClientToken", "traits": { "smithy.api#documentation": "The client token of the request entry that failed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An error for a billing adjustment request entry that failed validation.
" } }, "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentErrorList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentError" } }, "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentItem": { "type": "structure", "members": { "billingAdjustmentRequestId": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the created billing adjustment request.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.marketplaceagreement#ClientToken", "traits": { "smithy.api#documentation": "The client token provided in the corresponding request entry.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A successfully created billing adjustment request item.
" } }, "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentItemList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentItem" } }, "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice and the adjustment amount. The operation returns successfully created adjustment request IDs and any errors for entries that failed to process.
Each entry requires a unique clientToken for idempotency.
The unique identifier of the agreement associated with the invoice.
", "smithy.api#required": {} } }, "originalInvoiceId": { "target": "com.amazonaws.marketplaceagreement#InvoiceId", "traits": { "smithy.api#documentation": "The identifier of the original invoice to adjust.
", "smithy.api#required": {} } }, "adjustmentAmount": { "target": "com.amazonaws.marketplaceagreement#PositiveAmountUpto8Decimals", "traits": { "smithy.api#documentation": "The adjustment amount as a string representation of a decimal number in the currency of the invoice.
", "smithy.api#required": {} } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The 3-letter ISO 4217 currency code for the adjustment amount. Must match the currency code of the offer associated with the agreement (e.g., USD).
The reason code for the billing adjustment.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentDescription", "traits": { "smithy.api#documentation": "An optional detailed description of the adjustment reason.
" } }, "clientToken": { "target": "com.amazonaws.marketplaceagreement#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An individual entry in a batch billing adjustment request, specifying the invoice and adjustment details.
" } }, "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentRequestEntryList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentRequestEntry" } }, "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentRequestInput": { "type": "structure", "members": { "billingAdjustmentRequestEntries": { "target": "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentRequestEntryList", "traits": { "smithy.api#documentation": "A list of billing adjustment request entries. Each entry specifies the invoice and adjustment details.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentRequestOutput": { "type": "structure", "members": { "items": { "target": "com.amazonaws.marketplaceagreement#BatchCreateBillingAdjustmentItemList", "traits": { "smithy.api#documentation": "A list of successfully created billing adjustment items, each containing the billingAdjustmentRequestId and clientToken.
A list of errors for entries that failed validation, each containing the clientToken, error code, and message.
The unique identifier of the billing adjustment request.
", "smithy.api#required": {} } }, "originalInvoiceId": { "target": "com.amazonaws.marketplaceagreement#InvoiceId", "traits": { "smithy.api#documentation": "The identifier of the original invoice being adjusted.
", "smithy.api#required": {} } }, "adjustmentAmount": { "target": "com.amazonaws.marketplaceagreement#PositiveAmountUpto8Decimals", "traits": { "smithy.api#documentation": "The adjustment amount as a string representation of a decimal number.
", "smithy.api#required": {} } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the adjustment amount.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentStatus", "traits": { "smithy.api#documentation": "The current status of the billing adjustment request.
", "smithy.api#required": {} } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this billing adjustment request.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the billing adjustment request was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the billing adjustment request was last updated.
", "smithy.api#required": {} } }, "agreementType": { "target": "com.amazonaws.marketplaceagreement#AgreementType", "traits": { "smithy.api#documentation": "The type of agreement.
", "smithy.api#required": {} } }, "catalog": { "target": "com.amazonaws.marketplaceagreement#Catalog", "traits": { "smithy.api#documentation": "The catalog in which the agreement was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Summary view of a billing adjustment request.
" } }, "com.amazonaws.marketplaceagreement#BillingAdjustmentSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentSummary" } }, "com.amazonaws.marketplaceagreement#Boolean": { "type": "boolean" }, "com.amazonaws.marketplaceagreement#BoundedString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApproval": { "type": "structure", "members": { "approvalType": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalType", "traits": { "smithy.api#documentation": "The type of the agreement approval, which is BUYER_AGREEMENT_APPROVAL.
The unique identifier of the agreement approval.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalName", "traits": { "smithy.api#documentation": "The descriptive name of the agreement approval.
", "smithy.api#required": {} } }, "agreementRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement request that the agreement approval is for. Use GetAgreementRequest to retrieve the agreement request details.
The current status of the agreement approval. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and CANCELLED.
The account that started the agreement approval.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the agreement approval was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the agreement approval was last updated.
", "smithy.api#required": {} } }, "startedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when approvers could start acting on the agreement approval.
" } }, "expiresAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the agreement approval expires if it isn't approved or rejected.
" } }, "approvalNeededBy": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time by which the agreement approval must be completed.
", "smithy.api#required": {} } }, "levels": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalLevels", "traits": { "smithy.api#documentation": "The approval levels, in the order they are evaluated. Approvers at a level can act only after the previous level is approved. Each level lists its approvers and the decision of each one.
", "smithy.api#required": {} } }, "planInput": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanInput", "traits": { "smithy.api#documentation": "The approval plan and the note that the requester provided in StartAgreementApprovals.
The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.
A summary of the proposal received from the proposer.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The details of an approval that the buyer's organization requires before the agreement request can be accepted, including the approval levels and the decision of each approver.
" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalApproverInput": { "type": "structure", "members": { "agreementApprovalId": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement approval to approve.
", "smithy.api#required": {} } }, "purchaseOrders": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPurchaseOrders", "traits": { "smithy.api#documentation": "An optional list of purchase order references to associate with charges on the agreement request.
" } }, "note": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalNote", "traits": { "smithy.api#documentation": "An optional note that explains the decision (1-1000 characters).
" } }, "approverOutcomeIdToOverride": { "target": "com.amazonaws.marketplaceagreement#ApproverOutcomeId", "traits": { "smithy.api#documentation": "The approverOutcomeId of the approver to decide on behalf of. You must be the management account or a delegated administrator of your AWS organization to set this field. Use GetAgreementApproval to retrieve the approverOutcomeId of each approver.
The approval decision for an agreement approval.
" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalCriteria": { "type": "structure", "members": { "requiredApprovalCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of approvers in the group who must approve before the level is approved.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The approval criteria for a group of approvers.
" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalGroup": { "type": "structure", "members": { "approvalCriteria": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalCriteria", "traits": { "smithy.api#documentation": "The number of approvers in the group who must approve.
", "smithy.api#required": {} } }, "approvers": { "target": "com.amazonaws.marketplaceagreement#BuyerApproverOutcomes", "traits": { "smithy.api#documentation": "The approvers in the group and the decision of each one.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A group of approvers, the number of approvals the group requires, and the decision of each approver.
" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalGroups": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalGroup" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalLevel": { "type": "structure", "members": { "name": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalLevelName", "traits": { "smithy.api#documentation": "The name of the level.
" } }, "groups": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalGroups", "traits": { "smithy.api#documentation": "The group of approvers at this level.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A level of an agreement approval, with the decision of each approver.
" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalLevels": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalLevel" }, "traits": { "smithy.api#length": { "min": 1, "max": 6 } } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlan": { "type": "structure", "members": { "planReference": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPlanReference", "traits": { "smithy.api#documentation": "The identifier of the approval plan. Pass it in StartAgreementApprovals to start an agreement approval for this plan.
The name of the approval plan.
" } }, "levels": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanLevels", "traits": { "smithy.api#documentation": "The approval levels of the plan, in the order they are evaluated. Approvers at a level can act only after the previous level is approved.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An approval plan that the buyer's organization requires, with its approval levels and the approvers at each level.
" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanGroup": { "type": "structure", "members": { "approvalCriteria": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalCriteria", "traits": { "smithy.api#documentation": "The number of approvers in the group who must approve.
", "smithy.api#required": {} } }, "approvers": { "target": "com.amazonaws.marketplaceagreement#BuyerApprovers", "traits": { "smithy.api#documentation": "The approvers in the group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A group of approvers and the number of approvals the group requires.
" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanGroups": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanGroup" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanInput": { "type": "structure", "members": { "planReference": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPlanReference", "traits": { "smithy.api#documentation": "The identifier of the approval plan. Use GetAgreementRequestApprovalPlans to retrieve the approval plans of the agreement request.
An optional note for the approvers, such as the business reason for the purchase (1-1000 characters).
" } } }, "traits": { "smithy.api#documentation": "The approval plan to start an agreement approval for, and an optional note for the approvers.
" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanLevel": { "type": "structure", "members": { "name": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalLevelName", "traits": { "smithy.api#documentation": "The name of the level.
" } }, "groups": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanGroups", "traits": { "smithy.api#documentation": "The group of approvers at this level.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A level of an approval plan.
" } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanLevels": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalPlanLevel" }, "traits": { "smithy.api#length": { "min": 1, "max": 6 } } }, "com.amazonaws.marketplaceagreement#BuyerAgreementApprovalRejectionInput": { "type": "structure", "members": { "agreementApprovalId": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement approval to reject.
", "smithy.api#required": {} } }, "note": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalNote", "traits": { "smithy.api#documentation": "The reason for the rejection.
", "smithy.api#required": {} } }, "approverOutcomeIdToOverride": { "target": "com.amazonaws.marketplaceagreement#ApproverOutcomeId", "traits": { "smithy.api#documentation": "The approverOutcomeId of the approver to decide on behalf of. You must be the management account or a delegated administrator of your AWS organization to set this field. Use GetAgreementApproval to retrieve the approverOutcomeId of each approver.
The rejection decision for an agreement approval.
" } }, "com.amazonaws.marketplaceagreement#BuyerApproverOutcomes": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#ApproverOutcome" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplaceagreement#BuyerApprovers": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#Approver" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplaceagreement#ByolPricingTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Type of the term being updated.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } } }, "traits": { "smithy.api#documentation": "Enables you and your customers to move your existing agreements to AWS Marketplace. The customer won't be charged for product usage in AWS Marketplace because they already paid for the product outside of AWS Marketplace.
" } }, "com.amazonaws.marketplaceagreement#CallerIdentity": { "type": "structure", "members": { "principalArn": { "target": "com.amazonaws.marketplaceagreement#PrincipalArn", "traits": { "smithy.api#documentation": "The ARN of the IAM principal that made the call.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The identity of a caller.
" } }, "com.amazonaws.marketplaceagreement#CancelAgreement": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#CancelAgreementInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#CancelAgreementOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.
" } }, "com.amazonaws.marketplaceagreement#CancelAgreementCancellationRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#CancelAgreementCancellationRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#CancelAgreementCancellationRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request transitions to CANCELLED status and can no longer be approved or rejected by the buyer.
Only cancellation requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the cancellation request is in any other status.
The unique identifier of the agreement associated with the cancellation request.
", "smithy.api#required": {} } }, "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the cancellation request to cancel.
", "smithy.api#required": {} } }, "cancellationReason": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestCancellationReason", "traits": { "smithy.api#documentation": "A required message explaining why the cancellation request is being withdrawn (1-2000 characters).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#CancelAgreementCancellationRequestOutput": { "type": "structure", "members": { "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the cancelled cancellation request.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this cancellation request.
" } }, "reasonCode": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestReasonCode", "traits": { "smithy.api#documentation": "The original reason code provided when the cancellation request was created.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the original cancellation reason, if provided.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatus", "traits": { "smithy.api#documentation": "The updated status of the cancellation request, which is CANCELLED.
A message providing additional context about the cancellation request status.
" } }, "createdAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was originally created.
" } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was cancelled.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#CancelAgreementInput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#CancelAgreementOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#CancelAgreementPaymentRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#CancelAgreementPaymentRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#CancelAgreementPaymentRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows sellers (proposers) to cancel a payment request that is in PENDING_APPROVAL status. Once cancelled, the payment request transitions to CANCELLED status and can no longer be accepted or rejected by the buyer.
Only payment requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the payment request is in any other status.
The unique identifier of the payment request to cancel.
", "smithy.api#required": {} } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with the payment request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#CancelAgreementPaymentRequestOutput": { "type": "structure", "members": { "paymentRequestId": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the cancelled payment request.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this payment request.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestStatus", "traits": { "smithy.api#documentation": "The updated status of the payment request, which is CANCELLED.
The descriptive name of the payment request.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the payment request, if provided.
" } }, "chargeAmount": { "target": "com.amazonaws.marketplaceagreement#PositiveAmountUpto8Decimals", "traits": { "smithy.api#documentation": "The amount that was requested to be charged.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the charge amount.
" } }, "createdAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was originally created.
" } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was cancelled.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#CancelAgreementRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#CancelAgreementRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#CancelAgreementRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows buyers (acceptors) to cancel an agreement request that is in PENDING_APPROVAL status, or in APPROVED status when no agreement has been created from it. Once cancelled, the agreement request transitions to CANCELLED status and its open agreement approvals are cancelled.
The unique identifier of the agreement request to cancel.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#CancelAgreementRequestOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#Catalog": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9.-]+$" } }, "com.amazonaws.marketplaceagreement#Charge": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the charge.
" } }, "revision": { "target": "com.amazonaws.marketplaceagreement#ChargeRevision", "traits": { "smithy.api#documentation": "The revision number of the charge.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement that resulted in this charge.
" } }, "agreementType": { "target": "com.amazonaws.marketplaceagreement#AgreementType", "traits": { "smithy.api#documentation": "The type of agreement that resulted in this charge (for example, PurchaseAgreement).
The purchase order reference associated with the charge, if any.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the charge amount.
" } }, "amount": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The amount of the charge.
" } }, "time": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the charge will be incurred. This is available only when the charge date is known.
" } } }, "traits": { "smithy.api#documentation": "Represents a charge associated with an agreement, including amount, timing, and purchase order details.
" } }, "com.amazonaws.marketplaceagreement#ChargeId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^ch-[a-zA-Z0-9]+$" } }, "com.amazonaws.marketplaceagreement#ChargePercentage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 6 }, "smithy.api#pattern": "^(100(\\.0{1,2})?|[1-9]\\d?(\\.\\d{1,2})?|0\\.(0[1-9]|[1-9]\\d?))$" } }, "com.amazonaws.marketplaceagreement#ChargeRevision": { "type": "long", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.marketplaceagreement#ChargeSummary": { "type": "structure", "members": { "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The three-letter currency code for all charges (for example, USD).
" } }, "newAgreementValue": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The total value of the agreement, which includes any amendments.
" } }, "newAgreementValueAfterTax": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Expected new agreement value after estimated taxes are applied.
" } }, "expectedCharges": { "target": "com.amazonaws.marketplaceagreement#ExpectedChargeList", "traits": { "smithy.api#documentation": "A list of expected charges for the agreement request.
" } }, "estimatedTaxes": { "target": "com.amazonaws.marketplaceagreement#EstimatedTaxes", "traits": { "smithy.api#documentation": "Provides an aggregated view of estimated tax information for the agreement.
" } }, "itemizedCharges": { "target": "com.amazonaws.marketplaceagreement#ItemizedChargeList", "traits": { "smithy.api#documentation": "An itemized list of charges for the agreement request.
" } }, "invoicingEntity": { "target": "com.amazonaws.marketplaceagreement#InvoicingEntity", "traits": { "smithy.api#documentation": "The entity responsible for issuing the invoice.
" } } }, "traits": { "smithy.api#documentation": "The ChargeSummary provides a detailed breakdown of charges that are associated with an agreement request. This is applicable only when a request is created for a PurchaseAgreement.
Tax and invoicing fields (such as estimatedTaxes, amountAfterTax, newAgreementValueAfterTax, and invoicingEntity) are returned on a best-effort basis and do not cause the request to fail if unavailable.
A null tax amount can have two meanings:
Tax estimation was unavailable at the time of the request.
The charge timing is BILLING_PERIOD, so the charge amount is not determined at request time. In this case, the tax breakdown may still include the tax rate and type.
Category of the term.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier of the term.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "Defines the currency for the prices mentioned in the term.
" } }, "rateCards": { "target": "com.amazonaws.marketplaceagreement#ConfigurableUpfrontRateCardList", "traits": { "smithy.api#documentation": "A rate card defines the per unit rates for product dimensions.
" } }, "configuration": { "target": "com.amazonaws.marketplaceagreement#ConfigurableUpfrontPricingTermConfiguration", "traits": { "smithy.api#documentation": "Additional parameters specified by the acceptor while accepting the term.
" } } }, "traits": { "smithy.api#documentation": "Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
" } }, "com.amazonaws.marketplaceagreement#ConfigurableUpfrontPricingTermConfiguration": { "type": "structure", "members": { "selectorValue": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.
", "smithy.api#required": {} } }, "dimensions": { "target": "com.amazonaws.marketplaceagreement#DimensionList", "traits": { "smithy.api#documentation": "Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
" } }, "com.amazonaws.marketplaceagreement#ConfigurableUpfrontRateCardItem": { "type": "structure", "members": { "selector": { "target": "com.amazonaws.marketplaceagreement#Selector", "traits": { "smithy.api#documentation": "Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.
" } }, "constraints": { "target": "com.amazonaws.marketplaceagreement#Constraints", "traits": { "smithy.api#documentation": "Defines limits on how the term can be configured by acceptors.
" } }, "rateCard": { "target": "com.amazonaws.marketplaceagreement#RateCardList", "traits": { "smithy.api#documentation": "Defines the per unit rates for product dimensions.
" } } }, "traits": { "smithy.api#documentation": "Within the prepaid payment model defined under ConfigurableUpfrontPricingTerm, the RateCardItem defines all the various rate cards (including pricing and dimensions) that have been proposed.
The unique identifier for the error.
" } }, "message": { "target": "com.amazonaws.marketplaceagreement#ExceptionMessage", "traits": { "smithy.api#documentation": "Description of the error.
" } }, "resourceId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the resource involved in the conflict.
" } }, "resourceType": { "target": "com.amazonaws.marketplaceagreement#ResourceType", "traits": { "smithy.api#documentation": "The type of the resource involved in the conflict.
" } } }, "traits": { "smithy.api#documentation": "Request was denied due to a resource conflict.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.marketplaceagreement#Constraints": { "type": "structure", "members": { "multipleDimensionSelection": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Determines if buyers are allowed to select multiple dimensions in the rate card. The possible values are Allowed and Disallowed. The default value is Allowed.
Determines if acceptors are allowed to configure quantity for each dimension in rate card. The possible values are Allowed and Disallowed. The default value is Allowed.
Defines limits on how the term can be configured by acceptors.
" } }, "com.amazonaws.marketplaceagreement#ContactCompanyName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^(.)+$", "smithy.api#sensitive": {} } }, "com.amazonaws.marketplaceagreement#ContactType": { "type": "enum", "members": { "ACCEPTOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTOR" } } } }, "com.amazonaws.marketplaceagreement#ContactTypeList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#ContactType" } }, "com.amazonaws.marketplaceagreement#CountryCode": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Z]{2}$" } }, "com.amazonaws.marketplaceagreement#CreateAgreementRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#CreateAgreementRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#CreateAgreementRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ServiceQuotaExceededException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges, and returns a summary. Use AcceptAgreementRequest with the returned agreementRequestId to finalize the agreement.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "smithy.api#idempotencyToken": {} } }, "intent": { "target": "com.amazonaws.marketplaceagreement#Intent", "traits": { "smithy.api#documentation": "The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.
NEW \u2013 Creates a new agreement for terms in the request.
AMEND \u2013 Modifies an existing agreement with terms that are accepted in the request.
REPLACE \u2013 Creates a new agreement with accepted terms and replaces the existing agreement.
A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.
", "smithy.api#required": {} } }, "sourceAgreementIdentifier": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The agreement's identifier that the request acts upon.
This parameter is required for all non-NEW intents (i.e., AMEND or REPLACE). Don't provide this parameter if the intent is NEW.
The agreement proposal signed by the proposer. The proposal includes the requested resources and the terms that outline an agreement outcome.
This parameter is required if the intent is not AMEND.
Configuration for tax estimation in the agreement request response.
" } }, "acceptorContact": { "target": "com.amazonaws.marketplaceagreement#AcceptorContact", "traits": { "smithy.api#documentation": "The contact information of the acceptor.
Don't provide this parameter if the intent is AMEND.
The unique identifier of the agreement request created. Use this identifier with AcceptAgreementRequest to accept the agreement.
The type of agreement (for example, PurchaseAgreement).
Provides details of the charges associated with the agreement request. This is only applicable when a request is created for PurchaseAgreement.
The current status of the agreement request. Possible values include:
DRAFT \u2013 The agreement request has been created but not yet submitted for approval.
PENDING_APPROVAL \u2013 The agreement request is waiting for one or more approvers to decide.
APPROVED \u2013 All required approvals have been granted, but the agreement request wasn't accepted automatically. Call AcceptAgreementRequest to accept it. If the call fails, its error explains why.
ACCEPTED \u2013 The agreement request has been accepted and the resulting agreement has been created.
REJECTED \u2013 At least one approver rejected the agreement request. It won't proceed.
CANCELLED \u2013 The agreement request was cancelled before completion, by the acceptor or because the acceptor's account left its AWS organization.
Indicates whether the agreement request requires approval before it can be accepted. Values are REQUIRED and NOT_REQUIRED.
The date and time when the agreement request was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#CurrencyCode": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 3 }, "smithy.api#pattern": "^[A-Z]+$" } }, "com.amazonaws.marketplaceagreement#DayDuration": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 9 }, "smithy.api#pattern": "^P([1-9]\\d{0,6}D)$" } }, "com.amazonaws.marketplaceagreement#DescribeAgreement": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#DescribeAgreementInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#DescribeAgreementOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
" } }, "com.amazonaws.marketplaceagreement#DescribeAgreementInput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#DescribeAgreementOutput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
" } }, "acceptor": { "target": "com.amazonaws.marketplaceagreement#Acceptor", "traits": { "smithy.api#documentation": "The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.
The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.
The date and time when the agreement starts.
" } }, "endTime": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don\u2019t have end dates.
The date and time the offer was accepted or the agreement was created.
AcceptanceTime and StartTime can differ for future dated agreements (FDAs).
The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.
The estimated cost of the agreement.
" } }, "proposalSummary": { "target": "com.amazonaws.marketplaceagreement#ProposalSummary", "traits": { "smithy.api#documentation": "A summary of the proposal received from the proposer.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementStatus", "traits": { "smithy.api#documentation": "The current status of the agreement.
Statuses include:
ACTIVE \u2013 The terms of the agreement are active.
CANCELLED \u2013 The acceptor ended the agreement before the defined end date.
EXPIRED \u2013 The agreement ended on the defined end date.
RENEWED \u2013 The agreement was renewed into a new agreement (for example, an auto-renewal).
REPLACED \u2013 The agreement was replaced using an agreement replacement offer.
TERMINATED \u2013 The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).
The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. When an agreement isn't derived from another agreement, its InitialAgreementId is its own AgreementId.
The behavior of the agreement when it reaches its end date. For example, whether the agreement renews, and if it doesn't, the reason why.
This field is present for every active agreement that has an end date. It is not present for an agreement that has no end date, because such an agreement never reaches an end time. Pay-as-you-go agreements are the most common example. It is also not present for an agreement that is no longer active.
" } }, "freeTrialSummary": { "target": "com.amazonaws.marketplaceagreement#FreeTrialSummary", "traits": { "smithy.api#documentation": "The free trial details of the agreement. This field is present only when the agreement includes a free trial.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#Dimension": { "type": "structure", "members": { "dimensionKey": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The name of key value of the dimension.
", "smithy.api#required": {} } }, "dimensionValue": { "target": "com.amazonaws.marketplaceagreement#ZeroValueInteger", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of units of the dimension the acceptor has purchased.
For Agreements with ConfigurableUpfrontPricingTerm, the RateCard section will define the prices and dimensions defined by the seller (proposer), whereas the Configuration section will define the actual dimensions, prices, and units the buyer has chosen to accept.
Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.
" } }, "com.amazonaws.marketplaceagreement#DimensionList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#Dimension" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.marketplaceagreement#DocumentItem": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Category of the document. Document types include:
CustomEula \u2013 A custom EULA provided by you as seller. A URL for a EULA stored in an accessible Amazon S3 bucket is required for this document type.
CustomDsa \u2013 A custom Data Subscription Agreement (DSA) provided by you as seller. A URL for a DSA stored in an accessible Amazon S3 bucket is required for this document type.
StandardEula \u2013 The Standard Contract for AWS Marketplace (SCMP). For more information about SCMP, see the AWS Marketplace Seller Guide. You don't provide a URL for this type because it's managed by AWS Marketplace.
StandardDsa \u2013 DSA for AWS Marketplace. For more information about the DSA, see the AWS Data Exchange User Guide. You don't provide a URL for this type because it's managed by AWS Marketplace.
A URL to the legal document for buyers to read. Required when Type is CustomEula.
Version of standard contracts provided by AWS Marketplace. Required when Type is StandardEula or StandardDsa.
Includes the list of references to legal resources proposed by the proposer to the acceptor. Each DocumentItem refers to an individual reference.
The email address of the approver.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.marketplaceagreement#ApproverName", "traits": { "smithy.api#documentation": "The name of the approver.
" } } }, "traits": { "smithy.api#documentation": "An approver who is identified by an email address.
" } }, "com.amazonaws.marketplaceagreement#EmailApproverOutcome": { "type": "structure", "members": { "note": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalNote", "traits": { "smithy.api#documentation": "The note that the approver provided with the decision.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#ApproverOutcomeStatus", "traits": { "smithy.api#documentation": "The decision status of the approver. Possible values include QUEUED, PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and SKIPPED.
The date and time when the decision was last updated.
", "smithy.api#required": {} } }, "approverOutcomeId": { "target": "com.amazonaws.marketplaceagreement#ApproverOutcomeId", "traits": { "smithy.api#documentation": "The unique identifier of this approver in the agreement approval. An administrator of the buyer's AWS organization passes it as approverOutcomeIdToOverride to decide on the approver's behalf.
The email address of the approver.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.marketplaceagreement#ApproverName", "traits": { "smithy.api#documentation": "The name of the approver.
" } }, "purchaseOrders": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPurchaseOrders", "traits": { "smithy.api#documentation": "The purchase order references that the approver provided with the decision.
" } }, "overriddenBy": { "target": "com.amazonaws.marketplaceagreement#CallerIdentity", "traits": { "smithy.api#documentation": "The identity that decided on the approver's behalf. This field is empty unless an administrator of the buyer's AWS organization decided for the approver.
" } } }, "traits": { "smithy.api#documentation": "The decision of an approver who is identified by an email address.
" } }, "com.amazonaws.marketplaceagreement#EndTimeBehavior": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#EndTimeBehaviorType", "traits": { "smithy.api#documentation": "The behavior of the agreement when it reaches its end date.
Types include:
RENEW \u2013 A new agreement is created from the accepted terms of this agreement.
REPLACE \u2013 A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.
EXPIRE \u2013 The agreement ends and isn't renewed or replaced.
The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.
More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.
The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.
Reason codes include:
PROPOSER_RENEW_OPTED_OUT \u2013 The proposer opted out of renewing the agreement.
ACCEPTOR_RENEW_OPTED_OUT \u2013 The acceptor opted out of renewing the agreement.
NO_RENEWAL_TERM \u2013 The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.
RENEWAL_LIMIT_EXHAUSTED \u2013 The agreement reached the maximum number of renewals allowed by its renewal term.
The details of the renewal that applies at the end date of the agreement. This field is present when Type is RENEW. It is also present when ReasonCode is PROPOSER_RENEW_OPTED_OUT or ACCEPTOR_RENEW_OPTED_OUT. In those cases, it identifies the offer that the agreement would otherwise have renewed from. The field is null in all other cases.
The behavior of an agreement when it reaches its end date. For example, whether the agreement renews, and if it doesn't, the reason why.
" } }, "com.amazonaws.marketplaceagreement#EndTimeBehaviorReasonCode": { "type": "enum", "members": { "PROPOSER_RENEW_OPTED_OUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROPOSER_RENEW_OPTED_OUT" } }, "ACCEPTOR_RENEW_OPTED_OUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTOR_RENEW_OPTED_OUT" } }, "NO_RENEWAL_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_RENEWAL_TERM" } }, "RENEWAL_LIMIT_EXHAUSTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RENEWAL_LIMIT_EXHAUSTED" } } } }, "com.amazonaws.marketplaceagreement#EndTimeBehaviorType": { "type": "enum", "members": { "RENEW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RENEW" } }, "REPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPLACE" } }, "EXPIRE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRE" } } } }, "com.amazonaws.marketplaceagreement#Entitlement": { "type": "structure", "members": { "licenseArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement.
" } } }, "traits": { "smithy.api#documentation": "Represents an entitlement associated with an agreement.
" } }, "com.amazonaws.marketplaceagreement#EntitlementList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#Entitlement" } }, "com.amazonaws.marketplaceagreement#EntitlementType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z:]+$" } }, "com.amazonaws.marketplaceagreement#EstimatedCharges": { "type": "structure", "members": { "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "Defines the currency code for the charge.
" } }, "agreementValue": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The total known amount customer has to pay across the lifecycle of the agreement.
This is the total contract value if accepted terms contain ConfigurableUpfrontPricingTerm or FixedUpfrontPricingTerm. In the case of pure contract pricing, this will be the total value of the contract. In the case of contracts with consumption pricing, this will only include the committed value and not include any overages that occur.
If the accepted terms contain PaymentScheduleTerm, it will be the total payment schedule amount. This occurs when flexible payment schedule is used, and is the sum of all invoice charges in the payment schedule.
In case a customer has amended an agreement, by purchasing more units of any dimension, this will include both the original cost as well as the added cost incurred due to addition of new units.
This is 0 if the accepted terms contain UsageBasedPricingTerm without ConfigurableUpfrontPricingTerm or RecurringPaymentTerm. This occurs for usage-based pricing (such as SaaS metered or AMI/container hourly or monthly), because the exact usage is not known upfront.
Estimated cost of the agreement.
" } }, "com.amazonaws.marketplaceagreement#EstimatedTaxes": { "type": "structure", "members": { "breakdown": { "target": "com.amazonaws.marketplaceagreement#TaxBreakdown", "traits": { "smithy.api#documentation": "A list of tax breakdown information.
" } }, "totalAmount": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The total amount of tax aggregated from the tax breakdown.
" } } }, "traits": { "smithy.api#documentation": "Provides an aggregated view of estimated tax information.
" } }, "com.amazonaws.marketplaceagreement#ExceptionMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.marketplaceagreement#ExpectedCharge": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "Unique identifier of the charge for a given agreement.
" } }, "time": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the charge is due to be invoiced. This is available only when the charge date is known.
" } }, "amount": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The tax-exclusive amount of the charge. Only available when the charge amount is known.
" } }, "amountAfterTax": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The tax-inclusive amount the acceptor has to pay. The amount is only present for fixed charges.
" } }, "timing": { "target": "com.amazonaws.marketplaceagreement#Timing", "traits": { "smithy.api#documentation": "Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).
Provides an aggregated view of estimated tax information for this specific charge.
" } }, "purchaseOrderReference": { "target": "com.amazonaws.marketplaceagreement#PurchaseOrderReference", "traits": { "smithy.api#documentation": "The purchase order reference associated with the charge, if any.
" } } }, "traits": { "smithy.api#documentation": "Estimated charge for the request.
" } }, "com.amazonaws.marketplaceagreement#ExpectedChargeList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#ExpectedCharge" } }, "com.amazonaws.marketplaceagreement#Filter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.marketplaceagreement#FilterName", "traits": { "smithy.api#documentation": "The name of the filter.
" } }, "values": { "target": "com.amazonaws.marketplaceagreement#FilterValueList", "traits": { "smithy.api#documentation": "The filter value.
" } } }, "traits": { "smithy.api#documentation": "The filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as offerId or productId.
The percentage by which the price increases at each renewal, from 0.00 to 100.00 with up to two decimal places. A value of 0.00 means that the agreement renews at the same price.
A fixed price increase that is applied each time the agreement renews.
" } }, "com.amazonaws.marketplaceagreement#FixedUpfrontPricingTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Category of the term being updated.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "Defines the currency for the prices mentioned in this term.
" } }, "duration": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Contract duration for the terms.
" } }, "price": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Fixed amount to be charged to the customer when this term is accepted.
" } }, "grants": { "target": "com.amazonaws.marketplaceagreement#GrantList", "traits": { "smithy.api#documentation": "Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
" } } }, "traits": { "smithy.api#documentation": "Defines a prepaid pricing model where the customers are charged a fixed upfront amount.
" } }, "com.amazonaws.marketplaceagreement#FreeTrialPricingTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Category of the term.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the terms.
" } }, "duration": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Duration of the free trial period. The allowed duration depends on the product type. For SaaS products, the free trial lasts 7 to 90 days.
" } }, "grants": { "target": "com.amazonaws.marketplaceagreement#GrantList", "traits": { "smithy.api#documentation": "Entitlements granted to the acceptor of a free trial as part of an agreement execution.
" } } }, "traits": { "smithy.api#documentation": "Defines a short-term free pricing model where the buyers aren't charged anything within a specified limit.
" } }, "com.amazonaws.marketplaceagreement#FreeTrialSummary": { "type": "structure", "members": { "trialEndTime": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the free trial ends. For an agreement that includes both a free trial and usage-based pricing, the agreement converts to paid usage at this time.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the free trial of an agreement, including when the free trial ends.
" } }, "com.amazonaws.marketplaceagreement#GetAgreementApproval": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#GetAgreementApprovalInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#GetAgreementApprovalOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves detailed information about a specific agreement approval, including its approval levels, the approvers at each level, and the decision of each approver. The acceptor, or the management account or a delegated administrator of the acceptor's AWS organization, can call this operation.
", "smithy.api#examples": [ { "title": "Get an agreement approval", "input": { "agreementApprovalId": "apr-EXAMPLE9s0t1u2v3w4x" }, "output": { "buyerAgreementApproval": { "approvalType": "BUYER_AGREEMENT_APPROVAL", "agreementApprovalId": "apr-EXAMPLE9s0t1u2v3w4x", "name": "Example Analytics Platform sold by Example Corp", "agreementRequestId": "ar-EXAMPLE4a539b123d4EXAMPLE78", "status": "PENDING_APPROVAL", "requester": { "accountId": "123456789010" }, "createdAt": 1736935800, "updatedAt": 1737022200, "startedAt": 1736935800, "expiresAt": 1739527800, "approvalNeededBy": 1739527800, "levels": [ { "name": "Budget owner review", "groups": [ { "approvalCriteria": { "requiredApprovalCount": 1 }, "approvers": [ { "awsOrganizationApproverOutcome": { "approverOutcomeId": "aprout-EXAMPLE1e2f3g4h5i6j", "status": "PENDING_APPROVAL", "updatedAt": 1737022200 } } ] } ] } ], "planInput": { "planReference": "aplan-EXAMPLE7g8h9i0j1k2l", "requesterNote": "Annual subscription for the data platform team." }, "proposer": { "accountId": "444455556666", "legalName": "Example Corp" }, "proposalSummary": { "offerId": "ABCDEFGHIJKLMNOP123", "resources": [ { "id": "0EXAMPLE-8ce8-4814-bcf1-636EXAMPLEb5", "type": "SaaSProduct", "name": "Example Analytics Platform", "deployedOnAws": "DEPLOYED" } ], "visibilityScope": "PRIVATE" } } } } ], "smithy.api#readonly": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementApprovalInput": { "type": "structure", "members": { "agreementApprovalId": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement approval to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementApprovalOutput": { "type": "structure", "members": { "buyerAgreementApproval": { "target": "com.amazonaws.marketplaceagreement#BuyerAgreementApproval", "traits": { "smithy.api#documentation": "The details of the agreement approval, when it is a BUYER_AGREEMENT_APPROVAL.
Retrieves detailed information about a specific agreement cancellation request. Both sellers (proposers) and buyers (acceptors) can use this operation to view cancellation requests associated with their agreements.
", "smithy.api#examples": [ { "title": "Get a cancellation request", "input": { "agreementId": "agmt-752jqvg74yo7k", "agreementCancellationRequestId": "acr-sgew33rhsds" }, "output": { "agreementCancellationRequestId": "acr-sgew33rhsds", "agreementId": "agmt-752jqvg74yo7k", "reasonCode": "PRODUCT_DISCONTINUED", "description": "Product is being discontinued and no longer supported", "status": "VALIDATION_FAILED", "statusMessage": "Agreement is not in an active state", "createdAt": "2025-01-15T10:30:00Z", "updatedAt": "2025-01-16T10:30:00Z" } } ] } }, "com.amazonaws.marketplaceagreement#GetAgreementCancellationRequestInput": { "type": "structure", "members": { "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the cancellation request.
", "smithy.api#required": {} } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with the cancellation request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementCancellationRequestOutput": { "type": "structure", "members": { "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the cancellation request.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this cancellation request. Use DescribeAgreement to retrieve full agreement details.
The reason code provided for the cancellation.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the cancellation reason, if provided.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatus", "traits": { "smithy.api#documentation": "The current status of the cancellation request.
" } }, "statusMessage": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatusMessage", "traits": { "smithy.api#documentation": "A message providing additional context about the cancellation request status.
" } }, "createdAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was created.
" } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementContacts": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#GetAgreementContactsInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#GetAgreementContactsOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Obtains details about the acceptor's contact information for an active agreement that you participate in as the proposer, acceptor, or manufacturer.
If the acceptor's contact information isn't available, the operation succeeds but doesn't return acceptorContact. This happens when the acceptor didn't provide it, the information was removed, or the agreement isn't active.
The unique identifier of the agreement.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementContactsOutput": { "type": "structure", "members": { "acceptorContact": { "target": "com.amazonaws.marketplaceagreement#AcceptorContact", "traits": { "smithy.api#documentation": "The contact information that the acceptor provided when creating the agreement.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementEntitlements": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#GetAgreementEntitlementsInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#GetAgreementEntitlementsOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Obtains details about the entitlements of an agreement.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "agreementEntitlements" }, "smithy.api#readonly": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementEntitlementsInput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.marketplaceagreement#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of agreement entitlements to return in the response.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementEntitlementsOutput": { "type": "structure", "members": { "agreementEntitlements": { "target": "com.amazonaws.marketplaceagreement#AgreementEntitlementList", "traits": { "smithy.api#documentation": "A list of agreement entitlements which are part of the latest agreement.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination. The field is null if there are no more results.
Retrieves detailed information about a specific payment request. Both sellers (proposers) and buyers (acceptors) can use this operation to view payment requests associated with their agreements. The response includes the current status, charge details, timestamps, and the charge ID if the request has been approved.
The calling identity must be either the acceptor or proposer of the payment request. A ResourceNotFoundException is returned if the payment request does not exist.
The identifier of the payment request.
", "smithy.api#required": {} } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with the payment request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementPaymentRequestOutput": { "type": "structure", "members": { "paymentRequestId": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the payment request.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this payment request. Use DescribeAgreement to retrieve full agreement details.
The current status of the payment request. Possible values include:
VALIDATING \u2013 The payment request is being validated against agreement terms.
VALIDATION_FAILED \u2013 The payment request failed validation.
PENDING_APPROVAL \u2013 The payment request is awaiting buyer action.
APPROVED \u2013 The buyer has approved the payment request.
REJECTED \u2013 The buyer has rejected the payment request.
CANCELLED \u2013 The seller has cancelled the payment request.
An optional message providing additional context about the payment request status, such as a rejection reason or validation failure details.
" } }, "name": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestName", "traits": { "smithy.api#documentation": "The descriptive name of the payment request.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the payment request, if provided.
" } }, "chargeId": { "target": "com.amazonaws.marketplaceagreement#ChargeId", "traits": { "smithy.api#documentation": "The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests and follows the pattern ch-[a-zA-Z0-9]+.
The amount charged or to be charged to the buyer.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the charge amount.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#GetAgreementRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#GetAgreementRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves detailed information about a specific agreement request, including its status, intent, approval requirement, and charges. The acceptor, or the management account or a delegated administrator of the acceptor's AWS organization, can call this operation.
", "smithy.api#examples": [ { "title": "Get an agreement request", "input": { "agreementRequestId": "ar-EXAMPLE4a539b123d4EXAMPLE78" }, "output": { "agreementRequestId": "ar-EXAMPLE4a539b123d4EXAMPLE78", "agreementType": "PurchaseAgreement", "status": "PENDING_APPROVAL", "approvalRequirement": "REQUIRED", "intent": "NEW", "createdAt": 1736935800, "chargeSummary": { "currencyCode": "USD", "newAgreementValue": "100", "expectedCharges": [ { "id": "ch-EXAMPLE4b4296145c3EXAMPLE56", "purchaseOrderReference": "PO-123", "amount": "100", "timing": "ON_ACCEPTANCE" } ], "itemizedCharges": [ { "dimensionKey": "AdminUsers", "newQuantity": 5, "oldQuantity": 0, "incrementalChargeAmount": "50", "chargeReference": "ch-EXAMPLE4b4296145c3EXAMPLE56" }, { "dimensionKey": "ReadOnlyUsers", "newQuantity": 10, "oldQuantity": 0, "incrementalChargeAmount": "50", "chargeReference": "ch-EXAMPLE4b4296145c3EXAMPLE56" } ] }, "proposer": { "accountId": "444455556666" }, "proposalSummary": { "resources": [ { "id": "0EXAMPLE-8ce8-4814-bcf1-636EXAMPLEb5", "type": "SaaSProduct" } ], "offerId": "ABCDEFGHIJKLMNOP123" } } } ], "smithy.api#readonly": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementRequestApprovalPlans": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#GetAgreementRequestApprovalPlansInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#GetAgreementRequestApprovalPlansOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the approval plans that apply to an agreement request. Only the acceptor of the agreement request can call this operation. Each approval plan lists its approval levels and the approvers at each level. Pass the planReference of an approval plan to StartAgreementApprovals to start an agreement approval for it.
The unique identifier of the agreement request to retrieve the approval plans for.
", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.marketplaceagreement#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of approval plans to return in a single response (1-50). Default is 10.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementRequestApprovalPlansOutput": { "type": "structure", "members": { "items": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPlans", "traits": { "smithy.api#documentation": "An array of AgreementApprovalPlan objects, one for each approval plan that applies to the agreement request.
The token used for pagination. The field is null if there are no more results.
The unique identifier of the agreement request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementRequestOutput": { "type": "structure", "members": { "agreementRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement request.
" } }, "agreementType": { "target": "com.amazonaws.marketplaceagreement#AgreementType", "traits": { "smithy.api#documentation": "The type of agreement (for example, PurchaseAgreement).
The current status of the agreement request. Possible values include:
DRAFT \u2013 The agreement request has been created but not yet submitted for approval.
PENDING_APPROVAL \u2013 The agreement request is waiting for one or more approvers to decide.
APPROVED \u2013 All required approvals have been granted, but the agreement request wasn't accepted automatically. Call AcceptAgreementRequest to accept it. If the call fails, its error explains why.
ACCEPTED \u2013 The agreement request has been accepted and the resulting agreement has been created.
REJECTED \u2013 At least one approver rejected the agreement request. It won't proceed.
CANCELLED \u2013 The agreement request was cancelled before completion, by the acceptor or because the acceptor's account left its AWS organization.
Indicates whether the agreement request requires approval before it can be accepted. Values are REQUIRED and NOT_REQUIRED.
The unique identifier of the agreement that the agreement request is for.
" } }, "intent": { "target": "com.amazonaws.marketplaceagreement#Intent", "traits": { "smithy.api#documentation": "The purpose and desired outcome of the agreement request.
NEW \u2013 Creates a new agreement for terms in the request.
AMEND \u2013 Modifies an existing agreement with terms that are accepted in the request.
REPLACE \u2013 Creates a new agreement with accepted terms and replaces the existing agreement.
The date and time when the agreement request was created.
" } }, "chargeSummary": { "target": "com.amazonaws.marketplaceagreement#ChargeSummary", "traits": { "smithy.api#documentation": "Provides details of the charges associated with the agreement request. This is only applicable when a request is created for PurchaseAgreement.
The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.
A summary of the proposal received from the proposer.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementRequestTerms": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#GetAgreementRequestTermsInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#GetAgreementRequestTermsOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the terms proposed for an agreement request, such as pricing, legal, and renewal terms. The acceptor, or the management account or a delegated administrator of the acceptor's AWS organization, can call this operation. This operation is similar to GetAgreementTerms, but it takes an agreementRequestId instead of an agreementId.
The unique identifier of the agreement request.
", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.marketplaceagreement#AgreementRequestTermsMaxResults", "traits": { "smithy.api#documentation": "The maximum number of terms to return in the response.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementRequestTermsOutput": { "type": "structure", "members": { "terms": { "target": "com.amazonaws.marketplaceagreement#AgreementRequestTermList", "traits": { "smithy.api#documentation": "The terms proposed for the agreement request. The terms are fixed when the agreement request is created.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination. The field is null if there are no more results.
Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
The details include:
TermType \u2013 The type of term, such as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm.
TermID \u2013 The ID of the particular term, which is common between offer and agreement.
TermPayload \u2013 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 \u2013 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.
The unique identifier of the agreement.
", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.marketplaceagreement#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of agreements to return in the response.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetAgreementTermsOutput": { "type": "structure", "members": { "acceptedTerms": { "target": "com.amazonaws.marketplaceagreement#AcceptedTermList", "traits": { "smithy.api#documentation": "A subset of terms proposed by the proposer that have been accepted by the acceptor as part of the agreement creation.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination. The field is null if there are no more results.
Retrieves detailed information about a specific billing adjustment request. Sellers (proposers) can use this operation to view the status and details of a billing adjustment request they submitted.
", "smithy.api#examples": [ { "title": "Get a billing adjustment request", "input": { "billingAdjustmentRequestId": "ba-1a2b3c4d5e6f7g", "agreementId": "agmt-SvIzsqYMyQwI3GWgJAe17URx" }, "output": { "billingAdjustmentRequestId": "ba-1a2b3c4d5e6f7g", "agreementId": "agmt-SvIzsqYMyQwI3GWgJAe17URx", "adjustmentReasonCode": "OTHER", "originalInvoiceId": "E2E20230929a108cfae", "adjustmentAmount": "500.00", "currencyCode": "USD", "status": "PENDING", "description": "Customer requested adjustment", "createdAt": "2025-06-24T19:30:00Z", "updatedAt": "2025-06-24T19:30:00Z" } } ] } }, "com.amazonaws.marketplaceagreement#GetBillingAdjustmentRequestInput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with the billing adjustment request.
", "smithy.api#required": {} } }, "billingAdjustmentRequestId": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the billing adjustment request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#GetBillingAdjustmentRequestOutput": { "type": "structure", "members": { "billingAdjustmentRequestId": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the billing adjustment request.
", "smithy.api#required": {} } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this billing adjustment request.
", "smithy.api#required": {} } }, "adjustmentReasonCode": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentReasonCode", "traits": { "smithy.api#documentation": "The reason code for the billing adjustment.
", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The detailed description of the billing adjustment reason, if provided.
" } }, "originalInvoiceId": { "target": "com.amazonaws.marketplaceagreement#InvoiceId", "traits": { "smithy.api#documentation": "The identifier of the original invoice being adjusted.
", "smithy.api#required": {} } }, "adjustmentAmount": { "target": "com.amazonaws.marketplaceagreement#PositiveAmountUpto8Decimals", "traits": { "smithy.api#documentation": "The adjustment amount as a string representation of a decimal number.
", "smithy.api#required": {} } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the adjustment amount (e.g., USD).
The current status of the billing adjustment request.
", "smithy.api#required": {} } }, "statusMessage": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentStatusMessage", "traits": { "smithy.api#documentation": "A message providing additional context about the billing adjustment request status. This field is populated only when the status is VALIDATION_FAILED.
The date and time when the billing adjustment request was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the billing adjustment request was last updated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#GrantItem": { "type": "structure", "members": { "dimensionKey": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Unique dimension key defined in the product document. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.
" } }, "maxQuantity": { "target": "com.amazonaws.marketplaceagreement#PositiveIntegerWithDefaultValueOne", "traits": { "smithy.api#default": 1, "smithy.api#documentation": "Maximum amount of capacity that the buyer can be entitled to the given dimension of the product. If MaxQuantity is not provided, the buyer will be able to use an unlimited amount of the given dimension.
Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
" } }, "com.amazonaws.marketplaceagreement#GrantList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#GrantItem" } }, "com.amazonaws.marketplaceagreement#ISO8601Duration": { "type": "string", "traits": { "smithy.api#pattern": "^([-+]?)P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?$" } }, "com.amazonaws.marketplaceagreement#Intent": { "type": "enum", "members": { "NEW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NEW" } }, "AMEND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMEND" } }, "REPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPLACE" } } } }, "com.amazonaws.marketplaceagreement#InternalServerException": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.marketplaceagreement#RequestId", "traits": { "smithy.api#documentation": "The unique identifier for the error.
" } }, "message": { "target": "com.amazonaws.marketplaceagreement#ExceptionMessage", "traits": { "smithy.api#documentation": "Description of the error.
" } } }, "traits": { "smithy.api#documentation": "Unexpected error during processing of request.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.marketplaceagreement#InvoiceBillingPeriod": { "type": "structure", "members": { "month": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The billing period month. Valid range: 1-12.
", "smithy.api#range": { "min": 1, "max": 12 }, "smithy.api#required": {} } }, "year": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The billing period year.
", "smithy.api#range": { "min": 2023, "max": 2050 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The billing period for an invoice, specified by month and year.
" } }, "com.amazonaws.marketplaceagreement#InvoiceId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.marketplaceagreement#InvoiceType": { "type": "enum", "members": { "INVOICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVOICE" } }, "CREDIT_MEMO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREDIT_MEMO" } } } }, "com.amazonaws.marketplaceagreement#InvoicingEntity": { "type": "structure", "members": { "legalName": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Legal name of the entity issuing the invoice.
" } }, "branchName": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The branch where the issuing entity is operating from.
" } } }, "traits": { "smithy.api#documentation": "The entity responsible for issuing the invoice.
" } }, "com.amazonaws.marketplaceagreement#ItemizedCharge": { "type": "structure", "members": { "dimensionKey": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The dimension key as specified in the accepted term.
" } }, "newQuantity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The requested quantity for this dimension.
" } }, "oldQuantity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The existing quantity for this dimension from the source agreement. This value is 0 for NEW intent.
The identifier of the expected charge that this itemized charge contributes to.
" } }, "incrementalChargeAmount": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The total incremental charge amount for this dimension.
" } } }, "traits": { "smithy.api#documentation": "A breakdown of individual charges or line items within a billing or pricing context.
" } }, "com.amazonaws.marketplaceagreement#ItemizedChargeList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#ItemizedCharge" } }, "com.amazonaws.marketplaceagreement#LegalTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Category of the term being updated.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "documents": { "target": "com.amazonaws.marketplaceagreement#DocumentList", "traits": { "smithy.api#documentation": "List of references to legal resources proposed to the buyers. An example is the EULA.
" } } }, "traits": { "smithy.api#documentation": "Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).
" } }, "com.amazonaws.marketplaceagreement#LineItemGroupBy": { "type": "enum", "members": { "INVOICE_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVOICE_ID" } } } }, "com.amazonaws.marketplaceagreement#ListAgreementApprovals": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#ListAgreementApprovalsInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#ListAgreementApprovalsOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists agreement approvals available to you as a buyer. Use REQUESTER as the partyType to list the agreement approvals that your account started. Use AWS_ORGANIZATION_ADMIN to list the agreement approvals in your AWS organization, if your account is the management account or a delegated administrator of the organization. You can filter the results by agreement request, approval type, and status.
An optional parameter to filter agreement approvals by catalog (for example, AWSMarketplace).
The party type for the agreement approvals. Required parameter. Use REQUESTER to list agreement approvals for agreement requests that you created, or AWS_ORGANIZATION_ADMIN to list agreement approvals as an AWS Organizations administrator.
An optional parameter to filter agreement approvals for a specific agreement request.
" } }, "approvalType": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalType", "traits": { "smithy.api#documentation": "An optional parameter to filter agreement approvals by type. The only valid value is BUYER_AGREEMENT_APPROVAL.
An optional parameter to filter agreement approvals by status. Valid values include PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and CANCELLED. If you don't specify a status, agreement approvals of all statuses are returned.
The maximum number of agreement approvals to return in a single response (1-50). Default is 20.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#ListAgreementApprovalsOutput": { "type": "structure", "members": { "items": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalSummaries", "traits": { "smithy.api#documentation": "An array of AgreementApprovalSummary objects containing summary information about each agreement approval.
The token used for pagination. The field is null if there are no more results.
Lists agreement cancellation requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find cancellation requests by specifying their party type and applying optional filters.
PartyType is a required parameter. A ValidationException is returned if PartyType is not provided.
The party type for the cancellation requests. Required parameter. Use Proposer to list cancellation requests where you are the seller, or Acceptor to list cancellation requests where you are the buyer.
An optional parameter to filter cancellation requests for a specific agreement.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatus", "traits": { "smithy.api#documentation": "An optional parameter to filter cancellation requests by status.
" } }, "agreementType": { "target": "com.amazonaws.marketplaceagreement#AgreementType", "traits": { "smithy.api#documentation": "An optional parameter to filter cancellation requests by agreement type (e.g., PurchaseAgreement).
An optional parameter to filter cancellation requests by catalog (e.g., AWSMarketplace).
The maximum number of cancellation requests to return in the response.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#ListAgreementCancellationRequestsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination. The field is null if there are no more results.
An array of AgreementCancellationRequestSummary objects containing summary information about each cancellation request.
Allows acceptors to view charges and purchase orders that are associated with an agreement. The response includes details about all charges regardless of whether a purchase order is linked to each charge.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {} } }, "com.amazonaws.marketplaceagreement#ListAgreementChargesInput": { "type": "structure", "members": { "catalog": { "target": "com.amazonaws.marketplaceagreement#Catalog", "traits": { "smithy.api#documentation": "The catalog in which the charges were created.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
" } }, "agreementType": { "target": "com.amazonaws.marketplaceagreement#AgreementType", "traits": { "smithy.api#documentation": "Filter to retrieve charges of a specific agreement type (for example, PurchaseAgreement).
The maximum number of charges to return in the response.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#ListAgreementChargesOutput": { "type": "structure", "members": { "items": { "target": "com.amazonaws.marketplaceagreement#Charges", "traits": { "smithy.api#documentation": "A list of agreement charges.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination. The field is null if there are no more results.
Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping. Supports invoice-level aggregation with filtering by billing period, invoice type, and issued date.
The groupBy parameter is required and supports only INVOICE_ID as a value. The agreementId parameter is required.
The unique identifier of the agreement.
", "smithy.api#required": {} } }, "groupBy": { "target": "com.amazonaws.marketplaceagreement#LineItemGroupBy", "traits": { "smithy.api#documentation": "Specifies a grouping strategy for line items. Currently supports INVOICE_ID.
An optional filter to retrieve invoice information for a specific invoice.
" } }, "invoiceType": { "target": "com.amazonaws.marketplaceagreement#InvoiceType", "traits": { "smithy.api#documentation": "An optional filter for the type of invoice. Valid values are INVOICE and CREDIT_MEMO.
An optional filter for the billing period associated with the invoice.
" } }, "beforeIssuedTime": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "An optional filter for invoices issued before the specified timestamp.
" } }, "afterIssuedTime": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "An optional filter for invoices issued after the specified timestamp.
" } }, "maxResults": { "target": "com.amazonaws.marketplaceagreement#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in the response.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#ListAgreementInvoiceLineItemsOutput": { "type": "structure", "members": { "agreementInvoiceLineItemGroupSummaries": { "target": "com.amazonaws.marketplaceagreement#AgreementInvoiceLineItemGroupSummaries", "traits": { "smithy.api#documentation": "A list of grouped billing data objects.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination. The field is null if there are no more results.
Lists payment requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find payment requests by specifying their party type and applying optional parameters.
PartyType is a required parameter. A ValidationException is returned if PartyType is not provided. Pagination is supported through maxResults (1-50, default 50) and nextToken parameters.
The party type for the payment requests. Required parameter. Use Proposer to list payment requests where you are the seller, or Acceptor to list payment requests where you are the buyer.
An optional parameter to list payment requests by agreement type (e.g., PurchaseAgreement).
An optional parameter to list payment requests by catalog (e.g., AWSMarketplace).
An optional parameter to list payment requests for a specific agreement.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestStatus", "traits": { "smithy.api#documentation": "An optional parameter to list payment requests by status. Valid values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.
The maximum number of payment requests to return in a single response (1-50). Default is 50.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#ListAgreementPaymentRequestsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination. The field is null if there are no more results.
An array of PaymentRequestSummary objects containing summary information about each payment request.
Lists agreement requests available to you as a buyer (acceptor). You can filter the results by catalog, status, and resourceId.
An optional parameter to list agreement requests by catalog (for example, AWSMarketplace).
An optional parameter to list agreement requests by status. Valid values include DRAFT, PENDING_APPROVAL, APPROVED, ACCEPTED, REJECTED, and CANCELLED. If you don't specify a status, agreement requests of all statuses are returned.
An optional parameter to list agreement requests for a specific resource, such as a product.
" } }, "maxResults": { "target": "com.amazonaws.marketplaceagreement#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of agreement requests to return in a single response (1-50). Default is 20.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#ListAgreementRequestsOutput": { "type": "structure", "members": { "items": { "target": "com.amazonaws.marketplaceagreement#AgreementRequestSummaryList", "traits": { "smithy.api#documentation": "An array of AgreementRequestSummary objects containing summary information about each agreement request.
The token used for pagination. The field is null if there are no more results.
Lists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.
", "smithy.api#examples": [ { "title": "List billing adjustment requests", "input": { "agreementId": "agmt-SvIzsqYMyQwI3GWgJAe17URx" }, "output": { "items": [ { "billingAdjustmentRequestId": "ba-1a2b3c4d5e6f7g", "status": "PENDING", "agreementId": "agmt-SvIzsqYMyQwI3GWgJAe17URx", "originalInvoiceId": "E2E20230929a108cfae", "adjustmentAmount": "500.00", "currencyCode": "USD", "agreementType": "PurchaseAgreement", "catalog": "AWSMarketplace", "createdAt": "2025-06-24T19:30:00Z", "updatedAt": "2025-06-24T19:30:00Z" } ] } } ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" } } }, "com.amazonaws.marketplaceagreement#ListBillingAdjustmentRequestsInput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement to list billing adjustment requests for.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#BillingAdjustmentStatus", "traits": { "smithy.api#documentation": "An optional filter to return billing adjustment requests with the specified status.
" } }, "createdAfter": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "An optional filter to return billing adjustment requests created after the specified timestamp.
" } }, "createdBefore": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "An optional filter to return billing adjustment requests created before the specified timestamp.
" } }, "maxResults": { "target": "com.amazonaws.marketplaceagreement#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of billing adjustment requests to return in the response.
" } }, "catalog": { "target": "com.amazonaws.marketplaceagreement#Catalog", "traits": { "smithy.api#documentation": "An optional filter to return billing adjustment requests by catalog (e.g., AWSMarketplace).
An optional filter to return billing adjustment requests by agreement type (e.g., PurchaseAgreement).
A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#ListBillingAdjustmentRequestsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination. The field is null if there are no more results.
An array of BillingAdjustmentSummary objects containing summary information about each billing adjustment request.
Type of the term being updated.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "paymentDuePeriod": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The duration after an invoice is issued within which the payment is due. The duration is represented in the ISO 8601 format (for example, P30D for 30 days or P60D for 60 days).
Defines the net payment due period for the agreement, specifying when payment is due after an invoice is issued.
" } }, "com.amazonaws.marketplaceagreement#NextToken": { "type": "string", "traits": { "smithy.api#length": { "max": 8192 }, "smithy.api#pattern": "^[a-zA-Z0-9+/=_-]+$" } }, "com.amazonaws.marketplaceagreement#OfferId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^\\S{1,64}$" } }, "com.amazonaws.marketplaceagreement#OfferSetId": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,50}$" } }, "com.amazonaws.marketplaceagreement#OfferVisibilityScope": { "type": "enum", "members": { "PUBLIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUBLIC" } }, "PRIVATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIVATE" } } } }, "com.amazonaws.marketplaceagreement#OffsetDuration": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 6 }, "smithy.api#pattern": "^P(\\d{1,4}M|\\d{1,4}D)$" } }, "com.amazonaws.marketplaceagreement#OrganizationId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 34 }, "smithy.api#pattern": "^o-[a-z0-9]{10,32}$" } }, "com.amazonaws.marketplaceagreement#PartyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[A-Za-z]+$" } }, "com.amazonaws.marketplaceagreement#PaymentRequestApprovalStrategy": { "type": "enum", "members": { "AUTO_APPROVE_ON_EXPIRATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTO_APPROVE_ON_EXPIRATION" } }, "WAIT_FOR_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WAIT_FOR_APPROVAL" } } } }, "com.amazonaws.marketplaceagreement#PaymentRequestDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.marketplaceagreement#PaymentRequestId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^pr-[a-zA-Z0-9]+$" } }, "com.amazonaws.marketplaceagreement#PaymentRequestName": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 64 }, "smithy.api#pattern": "^.+$" } }, "com.amazonaws.marketplaceagreement#PaymentRequestRejectionReason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 250 } } }, "com.amazonaws.marketplaceagreement#PaymentRequestStatus": { "type": "enum", "members": { "VALIDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATING" } }, "VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION_FAILED" } }, "PENDING_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_APPROVAL" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } } } }, "com.amazonaws.marketplaceagreement#PaymentRequestStatusMessage": { "type": "string" }, "com.amazonaws.marketplaceagreement#PaymentRequestSummary": { "type": "structure", "members": { "paymentRequestId": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the payment request.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this payment request.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestStatus", "traits": { "smithy.api#documentation": "The current status of the payment request. Possible values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.
The descriptive name of the payment request.
" } }, "chargeId": { "target": "com.amazonaws.marketplaceagreement#ChargeId", "traits": { "smithy.api#documentation": "The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests.
" } }, "chargeAmount": { "target": "com.amazonaws.marketplaceagreement#PositiveAmountUpto8Decimals", "traits": { "smithy.api#documentation": "The amount charged or to be charged to the buyer.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the charge amount.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was last updated.
" } } }, "traits": { "smithy.api#documentation": "Summary view of a payment request.
" } }, "com.amazonaws.marketplaceagreement#PaymentRequestSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestSummary" } }, "com.amazonaws.marketplaceagreement#PaymentScheduleEntry": { "type": "structure", "members": { "chargeDateOffset": { "target": "com.amazonaws.marketplaceagreement#OffsetDuration", "traits": { "smithy.api#documentation": "The time between the start date of the renewed agreement and the date this installment is charged. The duration is represented in the ISO 8601 format in either whole months or whole days (for example, P1M for 1 month or P30D for 30 days). All installments in a schedule use the same unit.
The percentage of the total contract value of the renewed agreement that is charged in this installment. Valid values range from 0.01 to 100.00, with up to two decimal places.
The day of the month on which this installment is charged, from 1 to 31. Use this field to anchor the charge to a specific calendar day within the month identified by ChargeDateOffset. This field is supported only when ChargeDateOffset is expressed in months.
A single installment in a payment schedule template. Because the start date of the renewed agreement isn't known when the offer is created, the charge date of each installment is expressed as an offset from that start date rather than as an absolute date.
" } }, "com.amazonaws.marketplaceagreement#PaymentScheduleEntryList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#PaymentScheduleEntry" } }, "com.amazonaws.marketplaceagreement#PaymentScheduleTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Type of the term.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "Defines the currency for the prices mentioned in the term.
" } }, "schedule": { "target": "com.amazonaws.marketplaceagreement#ScheduleList", "traits": { "smithy.api#documentation": "List of the payment schedule where each element defines one installment of payment. It contains the information necessary for calculating the price.
" } } }, "traits": { "smithy.api#documentation": "Defines an installment-based pricing model where customers are charged a fixed price on different dates during the agreement validity period. This is used most commonly for flexible payment schedule pricing.
" } }, "com.amazonaws.marketplaceagreement#PaymentScheduleTermTemplate": { "type": "structure", "members": { "schedule": { "target": "com.amazonaws.marketplaceagreement#PaymentScheduleEntryList", "traits": { "smithy.api#documentation": "The installments that make up the payment schedule of the renewed agreement. The ChargePercentage values of all installments add up to 100.
Defines the payment schedule that is applied to the renewed agreement.
" } }, "com.amazonaws.marketplaceagreement#PercentageRange": { "type": "structure", "members": { "minValue": { "target": "com.amazonaws.marketplaceagreement#PriceIncreasePercentage", "traits": { "smithy.api#documentation": "The lowest percentage that the proposer can choose, from 0.00 to 100.00 with up to two decimal places.
The highest percentage that the proposer can choose, from 0.00 to 100.00 with up to two decimal places.
The percentage that is applied if the proposer doesn't choose a value before the adjustment deadline. Valid values range from 0.00 to 100.00, with up to two decimal places.
A range of price increase percentages that the proposer can choose from before the adjustment deadline of the agreement.
MinValue will be less than MaxValue, and DefaultValue will fall within the range. When the proposer authorizes a single percentage instead of a range, PriceIncrease is a FixedPercentage rather than a PercentageRange.
A fixed price increase percentage that is applied at each renewal.
" } }, "percentageRange": { "target": "com.amazonaws.marketplaceagreement#PercentageRange", "traits": { "smithy.api#documentation": "A range of price increase percentages that the proposer can choose from before the adjustment deadline of the agreement.
" } } }, "traits": { "smithy.api#documentation": "The price increase that is applied each time the agreement renews. Exactly one of the following fields is set.
" } }, "com.amazonaws.marketplaceagreement#PriceIncreasePercentage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 6 }, "smithy.api#pattern": "^(100(\\.0{1,2})?|[1-9]\\d?(\\.\\d{1,2})?|0(\\.\\d{1,2})?)$" } }, "com.amazonaws.marketplaceagreement#PricingCurrencyAmount": { "type": "structure", "members": { "amount": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The monetary amount before tax.
" } }, "maxAdjustmentAmount": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The maximum refundable amount as a string representation of a decimal number.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The 3-letter ISO 4217 currency code (for example, USD, EUR, JPY).
Monetary amounts associated with an invoice line item group.
" } }, "com.amazonaws.marketplaceagreement#PrincipalArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:[^:]+:[^:]+:[^:]*:[^:]*:.+$" } }, "com.amazonaws.marketplaceagreement#ProcurementToolApprover": { "type": "structure", "members": { "name": { "target": "com.amazonaws.marketplaceagreement#ApproverName", "traits": { "smithy.api#documentation": "The name of the procurement system.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A procurement system that approves through the buyer's procurement integration.
" } }, "com.amazonaws.marketplaceagreement#ProcurementToolApproverOutcome": { "type": "structure", "members": { "note": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalNote", "traits": { "smithy.api#documentation": "The note that the approver provided with the decision.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#ApproverOutcomeStatus", "traits": { "smithy.api#documentation": "The decision status of the approver. Possible values include QUEUED, PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and SKIPPED.
The date and time when the decision was last updated.
", "smithy.api#required": {} } }, "approverOutcomeId": { "target": "com.amazonaws.marketplaceagreement#ApproverOutcomeId", "traits": { "smithy.api#documentation": "The unique identifier of this approver in the agreement approval. An administrator of the buyer's AWS organization passes it as approverOutcomeIdToOverride to decide on the approver's behalf.
The name of the procurement system.
", "smithy.api#required": {} } }, "purchaseOrders": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPurchaseOrders", "traits": { "smithy.api#documentation": "The purchase order references that the approver provided with the decision.
" } }, "overriddenBy": { "target": "com.amazonaws.marketplaceagreement#CallerIdentity", "traits": { "smithy.api#documentation": "The identity that decided on the procurement system's behalf. This field is empty unless an administrator of the buyer's AWS organization decided for the procurement system.
" } } }, "traits": { "smithy.api#documentation": "The decision of a procurement system.
" } }, "com.amazonaws.marketplaceagreement#ProposalSummary": { "type": "structure", "members": { "resources": { "target": "com.amazonaws.marketplaceagreement#Resources", "traits": { "smithy.api#documentation": "The list of resources involved in the agreement.
" } }, "offerId": { "target": "com.amazonaws.marketplaceagreement#OfferId", "traits": { "smithy.api#documentation": "The unique identifier of the offer in AWS Marketplace.
" } }, "offerSetId": { "target": "com.amazonaws.marketplaceagreement#OfferSetId", "traits": { "smithy.api#documentation": "A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.
" } } }, "traits": { "smithy.api#documentation": "A summary of the proposal received from the proposer.
" } }, "com.amazonaws.marketplaceagreement#Proposer": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.marketplaceagreement#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the proposer.
" } } }, "traits": { "smithy.api#documentation": "Details of the party proposing the agreement terms,. This is commonly the seller for PurchaseAgreement.
The unique identifier of the charge to associate the purchase order with.
", "smithy.api#required": {} } }, "chargeRevision": { "target": "com.amazonaws.marketplaceagreement#ChargeRevision", "traits": { "smithy.api#documentation": "The revision of the charge.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this charge.
" } }, "purchaseOrderReference": { "target": "com.amazonaws.marketplaceagreement#PurchaseOrderReference", "traits": { "smithy.api#documentation": "The purchase order reference to associate with the charge.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a purchase order association to a charge within an agreement.
" } }, "com.amazonaws.marketplaceagreement#PurchaseOrderReference": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.marketplaceagreement#PurchaseOrders": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#PurchaseOrder" }, "traits": { "smithy.api#length": { "min": 1, "max": 86 } } }, "com.amazonaws.marketplaceagreement#RateCardItem": { "type": "structure", "members": { "dimensionKey": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.
" } }, "price": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Per unit price for the product dimension that's used for calculating the amount to be charged.
" } } }, "traits": { "smithy.api#documentation": "Defines the per unit rates for each individual product dimension.
" } }, "com.amazonaws.marketplaceagreement#RateCardList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#RateCardItem" } }, "com.amazonaws.marketplaceagreement#RecurringPaymentTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Type of the term being updated.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "Defines the currency for the prices mentioned in this term.
" } }, "billingPeriod": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Defines the recurrence at which buyers are charged.
" } }, "price": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Amount charged to the buyer every billing period.
" } } }, "traits": { "smithy.api#documentation": "Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.
" } }, "com.amazonaws.marketplaceagreement#RegistrationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[A-Za-z0-9+/=.:_-]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.marketplaceagreement#RejectAgreementApproval": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#RejectAgreementApprovalInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#RejectAgreementApprovalOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows the management account or a delegated administrator of the buyer's AWS organization to reject an agreement approval that is in PENDING_APPROVAL status, as the organization administrator approver or on behalf of another approver. Once rejected, the agreement approval and its agreement request transition to REJECTED status. You must provide a reason for the rejection.
The rejection decision for an agreement approval that the buyer's organization requires.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#RejectAgreementApprovalOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#RejectAgreementCancellationRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#RejectAgreementCancellationRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#RejectAgreementCancellationRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows buyers (acceptors) to reject a cancellation request that is in PENDING_APPROVAL status. Once rejected, the cancellation request transitions to REJECTED status and the agreement remains active. Buyers must provide a reason for the rejection.
Only cancellation requests in PENDING_APPROVAL status can be rejected. A ConflictException is thrown if the cancellation request is in any other status.
The unique identifier of the agreement associated with the cancellation request.
", "smithy.api#required": {} } }, "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the cancellation request to reject.
", "smithy.api#required": {} } }, "rejectionReason": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestRejectionReason", "traits": { "smithy.api#documentation": "The reason for rejecting the cancellation request (1-2000 characters). This message is visible to the seller.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#RejectAgreementCancellationRequestOutput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this cancellation request.
" } }, "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the rejected cancellation request.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatus", "traits": { "smithy.api#documentation": "The updated status of the cancellation request, which is REJECTED.
The rejection reason provided by the buyer.
" } }, "reasonCode": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestReasonCode", "traits": { "smithy.api#documentation": "The original reason code provided when the cancellation request was created.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the cancellation reason, if provided.
" } }, "createdAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was originally created.
" } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cancellation request was rejected.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#RejectAgreementPaymentRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#RejectAgreementPaymentRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#RejectAgreementPaymentRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows buyers (acceptors) to reject a payment request that is in PENDING_APPROVAL status. Once rejected, the payment request transitions to REJECTED status and cannot be accepted. Buyers can optionally provide a reason for the rejection.
Only payment requests in PENDING_APPROVAL status can be rejected. A ConflictException is thrown if the payment request is in any other status.
The unique identifier of the payment request to reject.
", "smithy.api#required": {} } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with the payment request.
", "smithy.api#required": {} } }, "rejectionReason": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestRejectionReason", "traits": { "smithy.api#documentation": "An optional reason for rejecting the payment request (1-250 characters). This message is visible to the seller.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#RejectAgreementPaymentRequestOutput": { "type": "structure", "members": { "paymentRequestId": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestId", "traits": { "smithy.api#documentation": "The unique identifier of the rejected payment request.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement associated with this payment request.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestStatus", "traits": { "smithy.api#documentation": "The updated status of the payment request, which is REJECTED.
The rejection reason provided by the buyer, if any.
" } }, "name": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestName", "traits": { "smithy.api#documentation": "The descriptive name of the payment request.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the payment request, if provided.
" } }, "chargeAmount": { "target": "com.amazonaws.marketplaceagreement#PositiveAmountUpto8Decimals", "traits": { "smithy.api#documentation": "The amount that was requested to be charged.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the charge amount.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was originally created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the payment request was rejected.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#RenewalSummary": { "type": "structure", "members": { "offerId": { "target": "com.amazonaws.marketplaceagreement#OfferId", "traits": { "smithy.api#documentation": "The unique identifier of the offer that provides the terms for the next renewal cycle. For most renewals, this is the same offer that the agreement was created from.
" } } }, "traits": { "smithy.api#documentation": "The details of the renewal that applies at the end date of an agreement.
" } }, "com.amazonaws.marketplaceagreement#RenewalTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Category of the term being updated.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "configuration": { "target": "com.amazonaws.marketplaceagreement#RenewalTermConfiguration", "traits": { "smithy.api#documentation": "Additional parameters specified by the acceptor while accepting the term.
" } }, "lockoutPeriod": { "target": "com.amazonaws.marketplaceagreement#DayDuration", "traits": { "smithy.api#documentation": "The renewal decision deadline, measured back from the end date of the agreement. This is the last day either party can opt in to or opt out of the renewal. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).
The field is null when no renewal decision deadline is set. In that case, either party can change the auto-renewal decision up to the end date of the agreement.
The maximum number of times the agreement can be renewed. The field is null when the number of renewals is unlimited.
After the agreement reaches this limit, it expires on its end date instead of renewing.
", "smithy.api#range": { "min": 1 } } }, "adjustmentDeadline": { "target": "com.amazonaws.marketplaceagreement#DayDuration", "traits": { "smithy.api#documentation": "The date by which the proposer must finalize the price increase for the next renewal, measured back from the end date of the agreement. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).
This field applies only when PriceIncrease is a PercentageRange. The field is null when PriceIncrease is a FixedPercentage, because the price increase is already fixed and there is nothing for the proposer to finalize. If the proposer doesn't finalize a value by the adjustment deadline, the DefaultValue of the range applies.
AdjustmentDeadline must be greater than LockoutPeriod.
The price increase that is applied each time the agreement renews. The field is null when the price doesn't change at renewal.
Defines how specific terms change each time the agreement renews. The field is null when no terms change at renewal.
Defines that on graceful expiration of the agreement (when the agreement ends on its pre-defined end date), a new agreement will be created using the accepted terms on the existing agreement. In other words, the agreement will be renewed. Presence of RenewalTerm in the offer document means that auto-renewal is allowed. The acceptor will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. The acceptor can also change this flag from True to False or False to True, within the limits set by LockoutPeriod and MaxRenewals. Setting the flag to True doesn't by itself guarantee that the agreement renews, because the proposer can also opt out.
Defines whether the acceptor has chosen to auto-renew the agreement when it reaches its end date. Can be set to True or False. The acceptor can change this value within the limits set by LockoutPeriod and MaxRenewals.
Additional parameters specified by the acceptor while accepting the term.
" } }, "com.amazonaws.marketplaceagreement#RequestId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9-]+$" } }, "com.amazonaws.marketplaceagreement#RequestedTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier of the term in the agreement proposal.
", "smithy.api#required": {} } }, "configuration": { "target": "com.amazonaws.marketplaceagreement#RequestedTermConfiguration", "traits": { "smithy.api#documentation": "Additional configuration for the requested terms. This configuration is applicable only to the terms that accept a customer-provided configuration, such as ConfigurableUpfrontPricingTerm.
Defines what is being accepted as part of the agreement creation or update request, and it includes their configurations.
" } }, "com.amazonaws.marketplaceagreement#RequestedTermConfiguration": { "type": "union", "members": { "configurableUpfrontPricingTermConfiguration": { "target": "com.amazonaws.marketplaceagreement#ConfigurableUpfrontPricingTermConfiguration" }, "renewalTermConfiguration": { "target": "com.amazonaws.marketplaceagreement#RenewalTermConfiguration" }, "variablePaymentTermConfiguration": { "target": "com.amazonaws.marketplaceagreement#VariablePaymentTermConfiguration" } }, "traits": { "smithy.api#documentation": "A tagged union that represents the term configuration provided by the acceptor. Only one configuration is accepted per term.
" } }, "com.amazonaws.marketplaceagreement#RequestedTermList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#RequestedTerm" }, "traits": { "smithy.api#length": { "min": 1, "max": 30 } } }, "com.amazonaws.marketplaceagreement#Resource": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the resource.
We mention the term resource, which is most commonly a product, so a resourceId is also a productId.
Type of the resource, which is the product (for example, SaaSProduct, AmiProduct, ContainerProduct).
The list of resources involved in the agreement.
" } }, "com.amazonaws.marketplaceagreement#ResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_/-]+$" } }, "com.amazonaws.marketplaceagreement#ResourceNotFoundException": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.marketplaceagreement#RequestId", "traits": { "smithy.api#documentation": "The unique identifier for the error.
" } }, "message": { "target": "com.amazonaws.marketplaceagreement#ExceptionMessage", "traits": { "smithy.api#documentation": "Description of the error.
" } }, "resourceId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier for the resource.
" } }, "resourceType": { "target": "com.amazonaws.marketplaceagreement#ResourceType", "traits": { "smithy.api#documentation": "The type of resource.
" } } }, "traits": { "smithy.api#documentation": "Request references a resource which does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.marketplaceagreement#ResourceType": { "type": "enum", "members": { "AGREEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Agreement" } }, "AGREEMENT_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AgreementRequest" } }, "AGREEMENT_PROPOSAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AgreementProposal" } }, "CHARGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Charge" } }, "PAYMENT_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PaymentRequest" } }, "INVOICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Invoice" } }, "AGREEMENT_CANCELLATION_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AgreementCancellationRequest" } }, "BILLING_ADJUSTMENT_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BillingAdjustmentRequest" } }, "AGREEMENT_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AgreementApproval" } }, "AGREEMENT_REQUEST_APPROVAL_PLAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AgreementRequestApprovalPlan" } } } }, "com.amazonaws.marketplaceagreement#Resources": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#Resource" } }, "com.amazonaws.marketplaceagreement#ScheduleItem": { "type": "structure", "members": { "chargeDate": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The date that the customer would pay the price defined in this payment schedule term. Invoices are generated on the date provided.
" } }, "chargeAmount": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The price that the customer would pay on the scheduled date (chargeDate).
" } } }, "traits": { "smithy.api#documentation": "An individual installment of the payment that includes the date and amount of the charge.
" } }, "com.amazonaws.marketplaceagreement#ScheduleList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#ScheduleItem" } }, "com.amazonaws.marketplaceagreement#SearchAgreements": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#SearchAgreementsInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#SearchAgreementsOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "agreementViewSummaries" } } }, "com.amazonaws.marketplaceagreement#SearchAgreementsInput": { "type": "structure", "members": { "catalog": { "target": "com.amazonaws.marketplaceagreement#Catalog", "traits": { "smithy.api#documentation": "The catalog in which the agreement was created.
" } }, "filters": { "target": "com.amazonaws.marketplaceagreement#FilterList", "traits": { "smithy.api#documentation": "The filter name and value pair used to return a specific list of results.
The following filters are supported:
ResourceIdentifier \u2013 The unique identifier of the resource.
ResourceType \u2013 Type of the resource, which is the product (AmiProduct, ContainerProduct, SaaSProduct, ProfessionalServicesProduct, or MachineLearningProduct).
PartyType \u2013 The party type of the caller. Use Proposer or Acceptor.
AcceptorAccountId \u2013 The AWS account ID of the party accepting the agreement terms.
OfferId \u2013 The unique identifier of the offer in which the terms are registered in the agreement token.
Status \u2013 The current status of the agreement. Values include ACTIVE, CANCELLED, EXPIRED, RENEWED, REPLACED, and TERMINATED.
BeforeEndTime \u2013 A date used to filter agreements with a date before the endTime of an agreement.
AfterEndTime \u2013 A date used to filter agreements with a date after the endTime of an agreement.
BeforeStartTime \u2013 A date used to filter agreements with a date before the startTime of an agreement.
AfterStartTime \u2013 A date used to filter agreements with a date after the startTime of an agreement.
BeforeLastUpdateTime \u2013 A date used to filter agreements with a date before the lastUpdateTime of an agreement.
AfterLastUpdateTime \u2013 A date used to filter agreements with a date after the lastUpdateTime of an agreement.
AgreementType \u2013 The type of agreement. Supported value includes PurchaseAgreement.
OfferSetId \u2013 A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.
EndTimeBehaviorType \u2013 What happens to the agreement when it reaches its end date. Values include RENEW, REPLACE, and EXPIRE.
EndTimeBehaviorReasonCode \u2013 The reason why the agreement doesn't renew at its end date. Values include PROPOSER_RENEW_OPTED_OUT, ACCEPTOR_RENEW_OPTED_OUT, NO_RENEWAL_TERM, and RENEWAL_LIMIT_EXHAUSTED.
InitialAgreementId \u2013 The unique identifier of the very first agreement in a chain of related agreements. Use this filter to return every agreement in the same chain.
LicenseArn \u2013 The Amazon Resource Name (ARN) of the AWS License Manager license associated with an entitlement granted by the agreement.
IncludesContactOfType \u2013 The type of contact information on file for the agreement. Supported value includes ACCEPTOR.
A proposer can use any combination of the preceding filters along with AgreementType, which is required.
The following filter combinations are supported when the PartyType is Acceptor:
AgreementType
AgreementType + Status
AgreementType + EndTime
AgreementType + Status + EndTime
AgreementType + ResourceIdentifier
AgreementType + ResourceIdentifier + EndTime
AgreementType + ResourceIdentifier + Status
AgreementType + ResourceIdentifier + Status + EndTime
AgreementType + ResourceType
AgreementType + ResourceType + EndTime
AgreementType + OfferId
AgreementType + OfferId + EndTime
AgreementType + OfferId + Status
AgreementType + OfferId + Status + EndTime
AgreementType + OfferSetId
AgreementType + OfferSetId + EndTime
AgreementType + OfferSetId + Status
AgreementType + OfferSetId + Status + EndTime
To filter by EndTime, you can use BeforeEndTime, AfterEndTime, or both.
An object that contains the SortBy and SortOrder attributes. For SearchAgreements, SortBy supports EndTime for both party types, and StartTime and LastUpdateTime only when PartyType is Proposer. The default SortBy value is EndTime.
The maximum number of agreements to return in the response.
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "A token to specify where to start pagination.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#SearchAgreementsOutput": { "type": "structure", "members": { "agreementViewSummaries": { "target": "com.amazonaws.marketplaceagreement#AgreementViewSummaryList", "traits": { "smithy.api#documentation": "A summary of the agreement, including top-level attributes (for example, the agreement ID, proposer, and acceptor).
" } }, "nextToken": { "target": "com.amazonaws.marketplaceagreement#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination. The field is null if there are no more results.
Category of selector.
" } }, "value": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Contract duration. This field supports the ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.
" } }, "com.amazonaws.marketplaceagreement#SendAgreementCancellationRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#SendAgreementCancellationRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#SendAgreementCancellationRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows sellers (proposers) to submit a cancellation request for an active agreement. The cancellation request is created in PENDING_APPROVAL status, at which point the buyer can review it.
The unique identifier of the agreement for which the cancellation request is being submitted.
", "smithy.api#required": {} } }, "reasonCode": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestReasonCode", "traits": { "smithy.api#documentation": "The reason code for the cancellation request.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.marketplaceagreement#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "smithy.api#idempotencyToken": {} } }, "description": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestDescription", "traits": { "smithy.api#documentation": "An optional detailed description of the cancellation reason (1-2000 characters).
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#SendAgreementCancellationRequestOutput": { "type": "structure", "members": { "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
" } }, "agreementCancellationRequestId": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestId", "traits": { "smithy.api#documentation": "The unique identifier for the created cancellation request.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestStatus", "traits": { "smithy.api#documentation": "The current status of the cancellation request. The initial status is PENDING_APPROVAL.
The reason code provided for the cancellation.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#AgreementCancellationRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the cancellation reason, if provided.
" } }, "createdAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The time when the cancellation request was created.
" } }, "updatedAt": { "target": "com.amazonaws.marketplaceagreement#Timestamp", "traits": { "smithy.api#documentation": "The time when the cancellation request was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#SendAgreementPaymentRequest": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#SendAgreementPaymentRequestInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#SendAgreementPaymentRequestOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes a VariablePaymentTerm. The payment request is created in PENDING_APPROVAL status, at which point the buyer can accept or reject it.
The agreement must be active and have a VariablePaymentTerm to support payment requests. The chargeAmount must not exceed the remaining available balance under the VariablePaymentTerm maxTotalChargeAmount.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "smithy.api#idempotencyToken": {} } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement for which the payment request is being submitted. Use GetAgreementTerms to retrieve agreement term details.
The unique identifier of the VariablePaymentTerm for the agreement that the payment request is being sent for.
A descriptive name for the payment request (5-64 characters).
", "smithy.api#required": {} } }, "chargeAmount": { "target": "com.amazonaws.marketplaceagreement#PositiveAmountUpto8Decimals", "traits": { "smithy.api#documentation": "The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.
A ValidationException is returned if the chargeAmount exceeds the available balance, if the agreement doesn't have an active VariablePaymentTerm, or if the termId is invalid.
An optional detailed description of the payment request (1-2000 characters).
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#SendAgreementPaymentRequestOutput": { "type": "structure", "members": { "paymentRequestId": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestId", "traits": { "smithy.api#documentation": "The unique identifier for the sent payment request.
" } }, "agreementId": { "target": "com.amazonaws.marketplaceagreement#AgreementId", "traits": { "smithy.api#documentation": "The agreement identifier for this payment request.
" } }, "status": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestStatus", "traits": { "smithy.api#documentation": "The current status of the payment request. The initial status is PENDING_APPROVAL.
The descriptive name of the payment request.
" } }, "description": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestDescription", "traits": { "smithy.api#documentation": "The detailed description of the payment request, if provided.
" } }, "chargeAmount": { "target": "com.amazonaws.marketplaceagreement#PositiveAmountUpto8Decimals", "traits": { "smithy.api#documentation": "The amount being charged to the buyer.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the charge amount (e.g., USD).
The time when the payment request was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#ServiceQuotaExceededException": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.marketplaceagreement#RequestId", "traits": { "smithy.api#documentation": "The unique identifier for the error.
" } }, "message": { "target": "com.amazonaws.marketplaceagreement#ExceptionMessage", "traits": { "smithy.api#documentation": "Description of the error.
" } }, "quotaCode": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The code of the quota that was exceeded.
" } }, "serviceCode": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The code of the service whose quota was exceeded.
" } }, "resourceType": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The type of the resource that exceeded the quota.
" } }, "resourceId": { "target": "com.amazonaws.marketplaceagreement#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the resource that exceeded the quota.
" } } }, "traits": { "smithy.api#documentation": "Request exceeded the maximum allowed limit (quota) for a specific resource or API operation.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.marketplaceagreement#Sort": { "type": "structure", "members": { "sortBy": { "target": "com.amazonaws.marketplaceagreement#SortBy", "traits": { "smithy.api#documentation": "The attribute on which the data is grouped, which can be EndTime, StartTime, or LastUpdateTime. StartTime and LastUpdateTime are supported only when PartyType is Proposer. The default value is EndTime.
The sorting order, which can be ASCENDING or DESCENDING. The default value is ASCENDING.
An object that contains the SortBy and SortOrder attributes.
Allows buyers (acceptors) to start the approvals that their organization requires for an agreement request. You start one agreement approval for each approval plan that you specify. Use GetAgreementRequestApprovalPlans to retrieve the approval plans of the agreement request. Once the agreement approvals start, the agreement request transitions to PENDING_APPROVAL status.
The unique identifier of the agreement request to start approvals for.
", "smithy.api#required": {} } }, "planInputs": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPlanInputs", "traits": { "smithy.api#documentation": "The approval plans to start agreement approvals for.
", "smithy.api#required": {} } }, "purchaseOrders": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalPurchaseOrders", "traits": { "smithy.api#documentation": "An optional list of purchase order references to associate with charges on the agreement request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#StartAgreementApprovalsOutput": { "type": "structure", "members": { "approvalSummaries": { "target": "com.amazonaws.marketplaceagreement#AgreementApprovalSummaries", "traits": { "smithy.api#documentation": "An array of AgreementApprovalSummary objects, one for each agreement approval that was started.
Category of the term being updated.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "refundPolicy": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Free-text field about the refund policy description that will be shown to customers as is on the website and console.
" } } }, "traits": { "smithy.api#documentation": "Defines the customer support available for the acceptors when they purchase the software.
" } }, "com.amazonaws.marketplaceagreement#TaxBreakdown": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#TaxBreakdownItem" } }, "com.amazonaws.marketplaceagreement#TaxBreakdownItem": { "type": "structure", "members": { "amount": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The estimated tax amount.
" } }, "rate": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The tax rate, in decimals.
" } }, "type": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The type of tax (for example, VAT, ST, or GST).
" } } }, "traits": { "smithy.api#documentation": "Represents a single tax breakdown entry with amount, rate, and type.
" } }, "com.amazonaws.marketplaceagreement#TaxConfiguration": { "type": "structure", "members": { "taxEstimation": { "target": "com.amazonaws.marketplaceagreement#TaxEstimation", "traits": { "smithy.api#default": "DISABLED", "smithy.api#documentation": "Toggle to estimate tax as part of the response. Values include ENABLED and DISABLED. Default is DISABLED.
Configuration controls for tax estimation in the agreement request.
" } }, "com.amazonaws.marketplaceagreement#TaxEstimation": { "type": "enum", "members": { "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } } } }, "com.amazonaws.marketplaceagreement#TermId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9+=;,.@\\-_]+$" } }, "com.amazonaws.marketplaceagreement#TermTemplate": { "type": "union", "members": { "paymentScheduleTermTemplate": { "target": "com.amazonaws.marketplaceagreement#PaymentScheduleTermTemplate", "traits": { "smithy.api#documentation": "Defines the payment schedule that is applied to the renewed agreement.
" } } }, "traits": { "smithy.api#documentation": "Defines how a specific type of term changes each time the agreement renews. Exactly one of the following fields is set.
" } }, "com.amazonaws.marketplaceagreement#TermTemplateList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#TermTemplate" } }, "com.amazonaws.marketplaceagreement#ThrottlingException": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.marketplaceagreement#RequestId", "traits": { "smithy.api#documentation": "The unique identifier for the error.
" } }, "message": { "target": "com.amazonaws.marketplaceagreement#ExceptionMessage", "traits": { "smithy.api#documentation": "Description of the error.
" } } }, "traits": { "smithy.api#documentation": "Request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.marketplaceagreement#Timestamp": { "type": "timestamp" }, "com.amazonaws.marketplaceagreement#Timing": { "type": "enum", "members": { "ON_ACCEPTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ON_ACCEPTANCE" } }, "SCHEDULED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCHEDULED" } }, "BILLING_PERIOD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BILLING_PERIOD" } }, "NOT_APPLICABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_APPLICABLE" } } } }, "com.amazonaws.marketplaceagreement#UnversionedTermType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#pattern": "^[A-Za-z]+$" } }, "com.amazonaws.marketplaceagreement#UpdatePurchaseOrders": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceagreement#UpdatePurchaseOrdersInput" }, "output": { "target": "com.amazonaws.marketplaceagreement#UpdatePurchaseOrdersOutput" }, "errors": [ { "target": "com.amazonaws.marketplaceagreement#AccessDeniedException" }, { "target": "com.amazonaws.marketplaceagreement#ConflictException" }, { "target": "com.amazonaws.marketplaceagreement#InternalServerException" }, { "target": "com.amazonaws.marketplaceagreement#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplaceagreement#ThrottlingException" }, { "target": "com.amazonaws.marketplaceagreement#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows acceptors to associate purchase orders with agreement charges after an agreement is created.
" } }, "com.amazonaws.marketplaceagreement#UpdatePurchaseOrdersInput": { "type": "structure", "members": { "purchaseOrders": { "target": "com.amazonaws.marketplaceagreement#PurchaseOrders", "traits": { "smithy.api#documentation": "Contains information about purchase order associations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplaceagreement#UpdatePurchaseOrdersOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplaceagreement#UsageBasedPricingTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Category of the term.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "Defines the currency for the prices mentioned in the term.
" } }, "rateCards": { "target": "com.amazonaws.marketplaceagreement#UsageBasedRateCardList", "traits": { "smithy.api#documentation": "List of rate cards.
" } } }, "traits": { "smithy.api#documentation": "Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.
" } }, "com.amazonaws.marketplaceagreement#UsageBasedRateCardItem": { "type": "structure", "members": { "rateCard": { "target": "com.amazonaws.marketplaceagreement#RateCardList", "traits": { "smithy.api#documentation": "Defines the per unit rates for product dimensions.
" } } }, "traits": { "smithy.api#documentation": "Within the pay-as-you-go model defined under UsageBasedPricingTerm, the UsageBasedRateCardItem defines an individual rate for a product dimension.
The unique identifier associated with the error.
" } }, "message": { "target": "com.amazonaws.marketplaceagreement#ExceptionMessage", "traits": { "smithy.api#documentation": "Description of the error.
" } }, "reason": { "target": "com.amazonaws.marketplaceagreement#ValidationExceptionReason", "traits": { "smithy.api#documentation": "The reason associated with the error.
" } }, "fields": { "target": "com.amazonaws.marketplaceagreement#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "The fields associated with the error.
" } } }, "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by the service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.marketplaceagreement#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The name of the field associated with the error.
", "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "See applicable actions.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by the service.
" } }, "com.amazonaws.marketplaceagreement#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceagreement#ValidationExceptionField" } }, "com.amazonaws.marketplaceagreement#ValidationExceptionReason": { "type": "enum", "members": { "CLOSED_AGREEMENT_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOSED_AGREEMENT_APPROVAL" } }, "QUEUED_AGREEMENT_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUEUED_AGREEMENT_APPROVAL" } }, "INVALID_AGREEMENT_APPROVAL_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_AGREEMENT_APPROVAL_ID" } }, "MISSING_AGREEMENT_APPROVAL_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_AGREEMENT_APPROVAL_ID" } }, "DUPLICATE_PLAN_REFERENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUPLICATE_PLAN_REFERENCE" } }, "INVALID_PLAN_INPUTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PLAN_INPUTS" } }, "PENDING_APPROVAL_AGREEMENT_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_APPROVAL_AGREEMENT_REQUEST" } }, "MISSING_BILLING_ADJUSTMENTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_BILLING_ADJUSTMENTS" } }, "BILLING_ADJUSTMENTS_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BILLING_ADJUSTMENTS_LIMIT_EXCEEDED" } }, "MISSING_INVOICE_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_INVOICE_ID" } }, "INVALID_ADJUSTMENT_AMOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ADJUSTMENT_AMOUNT" } }, "MISSING_ADJUSTMENT_AMOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_ADJUSTMENT_AMOUNT" } }, "INVALID_REASON_CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_REASON_CODE" } }, "MISSING_REASON_CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_REASON_CODE" } }, "MISSING_DESCRIPTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_DESCRIPTION" } }, "INVALID_INVOICE_ADJUSTMENT_PERIOD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_INVOICE_ADJUSTMENT_PERIOD" } }, "INVALID_CURRENCY_CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_CURRENCY_CODE" } }, "MISSING_CURRENCY_CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_CURRENCY_CODE" } }, "EXCEEDED_MAXIMUM_ADJUSTMENT_AMOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXCEEDED_MAXIMUM_ADJUSTMENT_AMOUNT" } }, "MISSING_BILLING_ADJUSTMENT_REQUEST_ENTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_BILLING_ADJUSTMENT_REQUEST_ENTRY" } }, "MULTIPLE_AGREEMENT_IDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MULTIPLE_AGREEMENT_IDS" } }, "INVALID_AGREEMENT_CANCELLATION_REQUEST_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_AGREEMENT_CANCELLATION_REQUEST_ID" } }, "MISSING_AGREEMENT_CANCELLATION_REQUEST_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_AGREEMENT_CANCELLATION_REQUEST_ID" } }, "MISSING_REASON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_REASON" } }, "INVALID_REASON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_REASON" } }, "INVALID_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_STATUS" } }, "INVALID_AGREEMENT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_AGREEMENT_ID" } }, "MISSING_AGREEMENT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_AGREEMENT_ID" } }, "INVALID_CATALOG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_CATALOG" } }, "INVALID_FILTERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_FILTERS" } }, "INVALID_FILTER_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_FILTER_NAME" } }, "MISSING_FILTER_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_FILTER_NAME" } }, "INVALID_FILTER_VALUES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_FILTER_VALUES" } }, "MISSING_FILTER_VALUES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_FILTER_VALUES" } }, "INVALID_SORT_BY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_SORT_BY" } }, "INVALID_SORT_ORDER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_SORT_ORDER" } }, "INVALID_NEXT_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_NEXT_TOKEN" } }, "INVALID_MAX_RESULTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_MAX_RESULTS" } }, "INVALID_TERM_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_TERM_ID" } }, "MISSING_TERM_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_TERM_ID" } }, "MISSING_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_NAME" } }, "INVALID_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_NAME" } }, "INVALID_DESCRIPTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_DESCRIPTION" } }, "MISSING_CHARGE_AMOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_CHARGE_AMOUNT" } }, "INVALID_CHARGE_AMOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_CHARGE_AMOUNT" } }, "MISSING_PAYMENT_REQUEST_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_PAYMENT_REQUEST_ID" } }, "INVALID_PAYMENT_REQUEST_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PAYMENT_REQUEST_ID" } }, "MISSING_PARTY_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_PARTY_TYPE" } }, "INVALID_PARTY_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PARTY_TYPE" } }, "UNSUPPORTED_FILTERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_FILTERS" } }, "INVALID_CLIENT_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_CLIENT_TOKEN" } }, "INVALID_INTENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_INTENT" } }, "MISSING_INTENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_INTENT" } }, "INVALID_SOURCE_AGREEMENT_IDENTIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_SOURCE_AGREEMENT_IDENTIFIER" } }, "MISSING_SOURCE_AGREEMENT_IDENTIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_SOURCE_AGREEMENT_IDENTIFIER" } }, "INVALID_AGREEMENT_PROPOSAL_IDENTIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_AGREEMENT_PROPOSAL_IDENTIFIER" } }, "MISSING_AGREEMENT_PROPOSAL_IDENTIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_AGREEMENT_PROPOSAL_IDENTIFIER" } }, "INVALID_REQUESTED_TERMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_REQUESTED_TERMS" } }, "MISSING_REQUESTED_TERMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_REQUESTED_TERMS" } }, "INVALID_REQUESTED_TERM_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_REQUESTED_TERM_ID" } }, "MISSING_REQUESTED_TERM_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_REQUESTED_TERM_ID" } }, "INVALID_REQUESTED_TERM_CONFIGURATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_REQUESTED_TERM_CONFIGURATION" } }, "MISSING_REQUESTED_TERM_CONFIGURATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_REQUESTED_TERM_CONFIGURATION" } }, "INVALID_AGREEMENT_REQUEST_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_AGREEMENT_REQUEST_ID" } }, "MISSING_AGREEMENT_REQUEST_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_AGREEMENT_REQUEST_ID" } }, "INVALID_PURCHASE_ORDERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PURCHASE_ORDERS" } }, "MISSING_PURCHASE_ORDERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_PURCHASE_ORDERS" } }, "INVALID_CHARGE_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_CHARGE_ID" } }, "MISSING_CHARGE_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_CHARGE_ID" } }, "INVALID_CHARGE_REVISION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_CHARGE_REVISION" } }, "MISSING_CHARGE_REVISION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_CHARGE_REVISION" } }, "INVALID_AGREEMENT_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_AGREEMENT_TYPE" } }, "INVALID_PURCHASE_ORDER_REFERENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PURCHASE_ORDER_REFERENCE" } }, "INACTIVE_AGREEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE_AGREEMENT" } }, "SUPERSEDED_AGREEMENT_PROPOSAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUPERSEDED_AGREEMENT_PROPOSAL" } }, "EXPIRED_AGREEMENT_PROPOSAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED_AGREEMENT_PROPOSAL" } }, "INVALID_ACCEPTOR_CONTACT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ACCEPTOR_CONTACT" } }, "MISSING_MANDATORY_TERMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_MANDATORY_TERMS" } }, "INCOMPATIBLE_TERMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INCOMPATIBLE_TERMS" } }, "MISSING_USAGE_AGREEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_USAGE_AGREEMENT" } }, "INVALID_INCREMENTAL_CHARGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_INCREMENTAL_CHARGE" } }, "MISSING_ACCOUNT_ADDRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_ACCOUNT_ADDRESS" } }, "UNSUPPORTED_ACTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_ACTION" } }, "INVALID_REJECTION_REASON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_REJECTION_REASON" } }, "INVALID_PAYMENT_REQUEST_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PAYMENT_REQUEST_STATUS" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } }, "DUPLICATE_CHARGES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUPLICATE_CHARGES" } }, "UNSUPPORTED_ACCOUNT_PLAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_ACCOUNT_PLAN" } }, "DUPLICATE_AGREEMENT_IN_ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUPLICATE_AGREEMENT_IN_ORGANIZATION" } }, "MISSING_AWS_LICENSE_MANAGER_USER_SUBSCRIPTIONS_SLR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_AWS_LICENSE_MANAGER_USER_SUBSCRIPTIONS_SLR" } }, "MISSING_PURCHASE_ORDER_REFERENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_PURCHASE_ORDER_REFERENCE" } }, "INVALID_RESOURCE_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_RESOURCE_ID" } }, "CLOSED_AGREEMENT_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOSED_AGREEMENT_REQUEST" } }, "INCOMPATIBLE_AGREEMENT_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INCOMPATIBLE_AGREEMENT_REQUEST" } }, "REJECTED_BY_AGREEMENT_APPROVAL_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED_BY_AGREEMENT_APPROVAL_POLICY" } }, "MISSING_PLAN_INPUTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_PLAN_INPUTS" } }, "INVALID_APPROVER_OUTCOME_ID_TO_OVERRIDE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_APPROVER_OUTCOME_ID_TO_OVERRIDE" } }, "INVALID_NOTE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_NOTE" } }, "MISSING_NOTE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_NOTE" } }, "INVALID_APPROVAL_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_APPROVAL_TYPE" } }, "MISSING_SORT_BY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_SORT_BY" } } } }, "com.amazonaws.marketplaceagreement#ValidityTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Category of the term being updated.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "agreementDuration": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "Defines the duration that the agreement remains active. If AgreementStartDate isn't provided, the agreement duration is relative to the agreement signature time. The duration is represented in the ISO_8601 format.
Defines the date when agreement starts. The agreement starts at 00:00:00.000 UTC on the date provided. If AgreementStartDate isn't provided, the agreement start date is determined based on agreement signature time.
Defines the date when the agreement ends. The agreement ends at 23:59:59.999 UTC on the date provided. If AgreementEndDate isn't provided, the agreement end date is determined by the validity of individual terms.
Defines the conditions that will keep an agreement created from this offer valid.
" } }, "com.amazonaws.marketplaceagreement#VariablePaymentTerm": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplaceagreement#UnversionedTermType", "traits": { "smithy.api#documentation": "Type of the term.
" } }, "id": { "target": "com.amazonaws.marketplaceagreement#TermId", "traits": { "smithy.api#documentation": "The unique identifier for the term.
" } }, "currencyCode": { "target": "com.amazonaws.marketplaceagreement#CurrencyCode", "traits": { "smithy.api#documentation": "Defines the currency for the prices mentioned in the term.
" } }, "maxTotalChargeAmount": { "target": "com.amazonaws.marketplaceagreement#BoundedString", "traits": { "smithy.api#documentation": "The maximum total amount that can be charged to the customer through variable payment requests under this term.
" } }, "configuration": { "target": "com.amazonaws.marketplaceagreement#VariablePaymentTermConfiguration", "traits": { "smithy.api#documentation": "Additional parameters specified by the acceptor while accepting the term.
" } } }, "traits": { "smithy.api#documentation": "Defines a payment model where sellers can submit variable payment requests up to a maximum charge amount, with configurable approval strategies and expiration timelines.
" } }, "com.amazonaws.marketplaceagreement#VariablePaymentTermConfiguration": { "type": "structure", "members": { "paymentRequestApprovalStrategy": { "target": "com.amazonaws.marketplaceagreement#PaymentRequestApprovalStrategy", "traits": { "smithy.api#documentation": "Defines the strategy for approving payment requests. Values include AUTO_APPROVE_ON_EXPIRATION and WAIT_FOR_APPROVAL
Defines the duration after which a payment request is automatically approved if no further action is taken. This only applies when the payment request approval strategy is set to AUTO_APPROVE_ON_EXPIRATION. The duration is represented in the ISO_8601 format (for example, P10D for 10 days).
Additional parameters specified by the acceptor while accepting the variable payment term.
" } }, "com.amazonaws.marketplaceagreement#ZeroValueInteger": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } } } }